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.

PATCHhttps://api.bird.com/workspaces/{workspaceId}/lists/{listId}

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

listId*string (uuid)

The ID of a list.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

Body

application/json

namestring

Name

Example: "US Customers"

descriptionnullable string

Example: "A list of all US customers"

consentTypenullable enum

The consent type for the list.

singledouble

tagsnullable array of string (uuid)

isProofnullable boolean

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

Response

200404422

The list was updated successfully.

Body

application/json

id*string

The unique identifier for the list.

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

name*string

The name of the list.

Example: "US Customers"

description*string

The description of the list.

Example: "A list of all US customers"

createdAtstring (date-time)

updatedAtstring (date-time)

contactCountinteger

The number of contacts in the list.

Example: 100

consentTypeenum

The consent type for the list.

singledouble

tagsarray of string (uuid)

The tags associated with the list.

isProofboolean

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

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/lists/{listId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "US Customers",
  "description": "A list of all US customers",
  "createdAt": "2024-12-21T16:21:06.480Z",
  "updatedAt": "2024-12-21T16:21:06.480Z",
  "contactCount": 100,
  "consentType": "single",
  "tags": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "isProof": false
}

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