Remove contacts from a list

Remove contacts from a list

delete

This endpoint will remove one or more contacts from the specified list.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

listIdstring · uuidRequired

The ID of a list.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

Body

contactsstring · uuid[] · min: 1 · max: 1000Optional

The list of contact ids to add to the list.

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

application/json

objectOptional

application/json

application/json

delete

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/lists/{listId}/contacts HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "contacts": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "itemsProcessed": 100
}

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

• List ID: 123e4567-e89b-12d3-a456-426614174000

• Contact ID: 12bd0e40-9361-4e32-8b26-99b4ab7eae09

Remove contacts from a list

In this example, we are removing contacts from a list given both IDs.

Request

curl -X DELETE "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists/123e4567-e89b-12d3-a456-426614174000/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "contacts": ["12bd0e40-9361-4e32-8b26-99b4ab7eae09"]
}'

Response (200 OK)

{
  "itemsProcessed": 1
}