Update a list
Update the specified list given its ID. This endpoint allows you to update the list's name, description, consent type, tags, and isProof flag.
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
Your workspace identifier.
b4e02c85-c6d2-4b15-8885-e09671799c61
listIdstring · uuidRequiredExample:
The ID of a list.
b4e02c85-c6d2-4b15-8885-e09671799c61
Body
namestring · min: 2 · max: 256OptionalExample:
Name
US Customers
descriptionstring | nullableOptionalExample:
A list of all US customers
consentTypestring · enum | nullableOptionalPossible values:
The consent type for the list.
tagsstring · uuid[] | nullableOptionalExample:
123e4567-e89b-12d3-a456-426614174000
isProofboolean | nullableOptional
The list is used as a proof list to use it as a test list in campaigns.
Responses
200
The list was updated successfully.
application/json
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
patch
PATCH /workspaces/{workspaceId}/lists/{listId} 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-07-13T02:24:37.037Z",
"updatedAt": "2025-07-13T02:24:37.037Z",
"contactCount": 100,
"consentType": "single",
"tags": [
"123e4567-e89b-12d3-a456-426614174000"
],
"isProof": true,
"counter": {
"count": 1,
"updatedAt": "2025-07-13T02:24:37.037Z"
}
}
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
Update a list
In this example, we're updating a list given its ID.
curl -X PATCH "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/lists" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
"name": "US Customers (old)",
"description": "US Customers"
}'
Last updated
Was this helpful?