Delete a List

Use delete to remove a list in Engage.

 
Endpoint and Methods
  • DELETE /_rest/v2/lists/:id

 

Note: If the list you want to delete is associated with an active campaign, you need to deactivate the campaign or remove the list from the active campaign before you can delete it.

Response code 202 returns a boolean value of true indicating that the list is in the process of deleting or has been deleted.

 

true

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

 

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

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

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

Response code 500 returns an error when trying to delete the list.

 

{
"message": "Something went wrong when trying to delete the list",
"status": 500
}