Add New Contacts

Use uploadcontacts to add one or more contacts to an existing list in Engage.

 
Endpoint and Methods
  • PUT /_rest/v2/lists/:id/uploadcontacts
Sample Request

{

  “contactInfo”:

[

 {

   “phone”: “1231231234”,

   “metadata”: {

     “Firstname”: “Abby”,

     “Lastname”: “Normal”,

     “email”: “Abbynormal@mail.com”

   }

 }

 {

   “phone”: “2342342345”

   “metadata”: {

     “Firstname”: “Tad”,

     “Lastname”: “Normal”,

     “email”: “Tadnormal@mail.com”

   }

 }

]

}

Note: “contactInfo” and “phone” are required fields in the Body. Other optional contact fields can be added under “metadata”.

Response code 201 returns a list with newly created contactIds under “contactRel”.

Response code 401 returns an error that the authorization token is invalid.

{
"message": "string",
"status": 401
}

Response code 422 returns a message that the listId is invalid or does not exist.

Response code 500 returns an error when an unknown internal error occurs.

{
  "message": "Something went wrong when trying to run the campaign",
  "status": 500
}