Create a list
Last updated
Was this helpful?
Last updated
Was this helpful?
Let's establish some of our data that will be used in the following examples:
Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352
AccessKey: abcd
In this example, we're creating a list.
curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
"name": "US Customers",
"description": "US Customers",
"consentType": "single",
"tags": [
"123e4567-e89b-12d3-a456-426614174000"
]
}'
This endpoint is used to create a new contact list. A contact list can be used to group contacts together.
Your workspace identifier.
b4e02c85-c6d2-4b15-8885-e09671799c61
Name
US Customers
A list of all US customers
The consent type for the list.
123e4567-e89b-12d3-a456-426614174000
The list is used as a proof list to use it as a test list in campaigns.
POST /workspaces/{workspaceId}/lists HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 152
{
"name": "US Customers",
"description": "A list of all US customers",
"consentType": "single",
"tags": [
"123e4567-e89b-12d3-a456-426614174000"
],
"isProof": true
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "US Customers",
"description": "A list of all US customers",
"createdAt": "2025-06-20T17:21:03.716Z",
"updatedAt": "2025-06-20T17:21:03.716Z",
"contactCount": 100,
"consentType": "single",
"tags": [
"123e4567-e89b-12d3-a456-426614174000"
],
"isProof": true,
"counter": {
"count": 1,
"updatedAt": "2025-06-20T17:21:03.716Z"
}
}