Sign in

v1

latestSwagger 2.0Private2026-08-04128286690.5 KB
Contact Lists

DELETE a List

Deletes the specified contact list and its membership. DELETE List requests are processed asynchronously, and you can track the status of the request by making a GET call to the URI shown in the _links property in the response.

delete/contact_lists/{list_id}

Path parameters

list_idstring uuid required

Unique ID of the list to delete

Response

Accepted

activity_idstring uuid

Unique ID for the delete list batch job.

statestring

The state of the request:

<p><ul> <li>initialized - request has been received</li> <li>processing - request is being processed</li> <li>completed - job completed</li> <li>cancelled - request was cancelled</li> <li>failed - job failed to complete</li> <li>timed_out - the request timed out before completing"</li> </ul> </p>
created_atstring date-time

Date and time that the request was received, in ISO-8601 format.

updated_atstring date-time

Date and time that the request status was updated, in ISO-8601 format.

percent_doneinteger

Job completion percentage

activity_errorsstring[]

Array of messages describing the errors that occurred.

Example response

{
  "state": "initialized",
  "created_at": "2016-03-03T10:53:04-05:00",
  "updated_at": "2016-03-03T10:56:29-05:00",
  "percent_done": 1,
  "activity_errors": [
    "Message describing the error condition."
  ],
  "_links": {
    "self": {
      "href": "/v3/activities/04fa57a7-cf55-4185-cc1a-58ed29bf0a6a"
    }
  }
}