Update a list

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.

patch

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

Authorizations

MessageBird_userMessageBird_accessKey

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

namestring · min: 2 · max: 256

Name

Example: US Customers

descriptionstring | nullable

Example: A list of all US customers

isProofboolean | nullable

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

consentTypestring · enum | nullable

The consent type for the list.

Options: single, double

tagsstring · uuid[] | nullable

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.bird.com/workspaces/{workspaceId}/lists/{listId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"US Customers","description":"A list of all US customers","consentType":"single","tags":["123e4567-e89b-12d3-a456-426614174000"]}'

200

404

422

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "US Customers",
  "description": "A list of all US customers",
  "createdAt": "2025-02-21T18:13:57.217Z",
  "updatedAt": "2025-02-21T18:13:57.217Z",
  "contactCount": 100,
  "isProof": true,
  "counter": {
    "count": 1,
    "updatedAt": "2025-02-21T18:13:57.217Z"
  },
  "consentType": "single",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

The list was updated successfully.

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)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "US Customers (old)",
  "description": "US Customers",
  "contactCount": 0,
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "isProof": false,
  "consentType": "single", 
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z"
}