Add contacts to a list

POST

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

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

路径参数

workspaceId

string

The unique identifier of the workspace.

listId

string

The ID of a list.

请求载荷

contacts

array of string

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.

identifiers

array of object

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

显示子参数

identifiers.key

string

必填

The identifier key (e.g., "emailaddress", "phonenumber").

identifiers.value

string

必填

The identifier value (e.g., "user@example.com", "+31612345678").

响应载荷

itemsProcessed

integer

必填

The number of contacts that were processed.

代码示例

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/lists/{listId}/contacts' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

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": "test@example.com" },
{ "key": "phonenumber", "value": "+31600000000" } ]

Add a contact to a list using Contact ID

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

代码示例

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

代码示例

{
  "itemsProcessed": 1
}

Add a contact to a list using Contact identifiers

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

代码示例

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": "test@example.com" }, 
		{ "key": "phonenumber", "value": "+31600000000" }
	]
}'

代码示例

{
  "itemsProcessed": 1
}