Add contacts to a list

Add contacts to a list

This endpoint will add one or more contacts to the specified list.

POSThttps://api.bird.com/workspaces/{workspaceId}/lists/{listId}/contacts

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

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

listId*string (uuid)

The ID of a list.

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

Body

application/json

contactsarray of string (uuid)

The list of contact ids to add to the list.

Response

201404422

The contacts were added 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.

Body

application/json

itemsProcessed*integer

The number of contacts that were processed.

Example: 100

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/lists/{listId}/contacts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201404422

{
  "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

Add a contact to a list

In this example, we're adding a contact to a list given both IDs.

Request

curl -X POST "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
}