Add contacts to a list

Add contacts to a list

post

https://api.bird.comhttp://localhost:3000https://api.bird.ai

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

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

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

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

application/json

contactsstring · uuid[] · nullableOptional

The list of contact ids to add to the list. Can be empty or null if identifiers are provided. Maximum combined count of contacts and identifiers is 100, validated by the API.

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

Responses

201

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.

application/json

itemsProcessedintegerRequired

The number of contacts that were processed.

Example: 100

404

The workspace or list was not found.

application/json

422

The HTTP request is well-formed but was unable to be processed. The HTTP response should include details about the error.

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "contacts": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "identifiers": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

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

• Contact Identifier:

  "identifiers": [ { "key": "emailaddress", "value": "[email protected]" }, { "key": "phonenumber", "value": "[phone]" } ]

Add a contact to a list using Contact ID

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)

Add a contact to a list using Contact identifiers

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

Request

curl -X POST 'https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists/123e4567-e89b-12d3-a456-426614174000/contacts' \
  -H "Authorization: AccessKey abcd" \
  -H 'Content-Type: application/json' \
--data-raw '{
	"identifiers": [
		{ "key": "emailaddress", "value": "[email protected]" }, 
		{ "key": "phonenumber", "value": "[phone]" }
	]
}'

Response (200 - OK)