Create a List

Use save to create and save a new list in Engage.

 

Endpoint and methods
  • POST: /api/v2/lists/save

 

Parameters

Example Value

 

{

  "listName": "Bob's List"

}

Response code 200 returns a list object upon successfully creating a list.

 

 {
"listName": "Bob's List",
"listId": "51i8c0edotame81bb4cbf000",
"description": "List of Bob's contacts",
"customerId": 9999999,
"modifiedDate": "2019-06-18T00:14:03Z",
"modifiedBy": "sspeirs",
"createdDate": "2019-06-18T00:14:03Z",
"createdBy": "sspeirs",
"deleteFlag": "false",
"campaignRel": [
"4kk11065jkl0985bb48mf054"
],
"contactRel": [
"4kk11065jkl0985bb48mf054"
]
}

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

 

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

Response code 422 returns a message that the listName parameter is required.



{
"message": "The 'listName' parameter is required",
"status": 422
}

Response code 500 returns an error during list creation.

 

{
"message": "Something went wrong during list creation",
"status": 500
}