Remove contacts from a list

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.

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"]
}'

{
  "itemsProcessed": 1
}

Last updated 2 months ago

Was this helpful?

Remove contacts from a list

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

delete

/workspaces/{workspaceId}/lists/{listId}/contacts

Authorizations

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[]

The list of contact ids to add to the list.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.bird.com/workspaces/{workspaceId}/lists/{listId}/contacts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"contacts":["123e4567-e89b-12d3-a456-426614174000"]}'

200

404

422

{
  "itemsProcessed": 100
}

The contacts were removed successfully, and the number of contacts that were processed is returned. If it doesn't match the number of contacts provided, it means some of the contacts were not processed.