Update a list

Update a list

patch

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

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

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

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

namestring · min: 2 · max: 256Optional

Name

Example: US Customers

descriptionstring · nullableOptionalExample: A list of all US customers

consentTypestring · enum · nullableOptional

The consent type for the list.

Possible values:

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

idstringRequired

The unique identifier for the list.

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

namestringRequired

The name of the list.

Example: US Customers

descriptionstringRequired

The description of the list.

Example: A list of all US customers

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

contactCountintegerOptional

The number of contacts in the list.

Example: 100

consentTypestring · enumOptional

The consent type for the list.

Possible values:

tagsstring · uuid[]Optional

The tags associated with the list.

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

isProofbooleanOptional

The list is used as a proof list to use it as a test list in campaigns.

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

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

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/lists/{listId} HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-03-09T21:44:52.835Z",
  "updatedAt": "2026-03-09T21:44:52.835Z",
  "contactCount": 100,
  "consentType": "single",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "isProof": true,
  "counter": {
    "count": 1,
    "updatedAt": "2026-03-09T21:44:52.835Z"
  }
}

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.

Request

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

Response (200 OK)