Create a contact

Create a contact

The contact creation endpoint allows adding a new contact with multiple identifiers, attributes, and lists, specifying their details and associations during the creation process.

post

/workspaces/{workspaceId}/contacts

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

Your workspace identifier.

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

Body

displayNamestring · min: 1 · max: 150required

The display name for the contact.

Example: John Doe

attributesobject | nullable

A map of key-value pairs, where the values are boolean, number, or string, or a non-empty array of those, or null

Example: {"firstName":"John","lastName":"Smith","rating":9.6,"cookiesAccepted":false,"labels":["A","B","C"]}

identifiersobject[] | nullable

accountIdsstring[] · min: 1 · max: 10

listIdsstring[] · min: 1 · max: 10

Other propertiesany

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.bird.com/workspaces/{workspaceId}/contacts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "displayName": "John Doe",
    "attributes": {
      "firstName": "John",
      "lastName": "Smith",
      "rating": 9.6,
      "cookiesAccepted": false,
      "labels": [
        "A",
        "B",
        "C"
      ]
    },
    "identifiers": [
      {
        "key": "secondaryEmailAddress",
        "value": "[e-mail]",
        "properties": {
          "countryCode": "US",
          "isGmail": true
        }
      }
    ],
    "accountIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "listIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }'

201

404

409

422

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "computedDisplayName": "John Doe",
  "createdAt": "2025-02-28T01:38:03.720Z",
  "updatedAt": "2025-02-28T01:38:03.720Z",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "attributes": {
    "firstName": "John",
    "lastName": "Smith",
    "rating": 9.6,
    "cookiesAccepted": false,
    "labels": [
      "A",
      "B",
      "C"
    ]
  },
  "identifierCount": 2,
  "featuredIdentifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "accountIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "listIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

The contact was created 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

Create a contact with identifiers

In this example, we're creating a contact providing identifiers. To know more about identifiers, please refer to this documentation.

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "identifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "displayName": "John Doe"
}'

Response (200 - OK)

{
  "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "computedDisplayName": "John Doe",
  "featuredIdentifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "identifierCount": 1,
  "attributes": {
    "displayName": "John Doe",
    "emailaddress": [
      "[e-mail]"
    ],
    "initialReference": "028d45dd-8e3f-43bb-8aa5-9d6833f08945",
    "timezone": "America/Sao_Paulo"
  },
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z"
}

Create a contact with attributes

In this example, we're creating a contact providing attributes. To know more about attributes, please refer to this documentation.

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "displayName": "John Doe",
  "attributes": {
    "firstName": "John",
    "lastName": "Doe"
  }
}'

Response (200 - OK)

{
  "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "computedDisplayName": "John",
  "identifierCount": 0,
  "attributes": {
    "firstName": "John",
    "initialReference": "32d6f4f9-7e9c-4271-bd83-9d6976808f2f",
    "lastName": "Doe",
    "timezone": "America/Sao_Paulo"
  },
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z"
}

Create a contact with lists

In this example, we're creating a contact providing list IDs. To knoe more about lists, please refer to this documentation.

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "displayName": "John Doe",
  "listIds": ["12bd0e40-9361-4e32-8b26-99b4ab7eae09"]
}'

Response (200 - OK)

{
  "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "computedDisplayName": "",
  "identifierCount": 0,
  "attributes": {
    "initialReference": "32d6f4f9-7e9c-4271-bd83-9d6976808f2f",
    "timezone": "America/Sao_Paulo"
  },
  "listIds": [
    "12bd0e40-9361-4e32-8b26-99b4ab7eae09"
  ],
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z"
}

Create a contact with providing all the details

In this example, we're creating a contact providing all the examples above.

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/contacts" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "displayName": "John Doe",
  "listIds": ["12bd0e40-9361-4e32-8b26-99b4ab7eae09"],
  "identifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "attributes": {
    "firstName": "John",
    "lastName": "Doe"
  }
}'

Response (200 - OK)

{
  "id": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "computedDisplayName": "John",
  "featuredIdentifiers": [
    {
      "key": "emailaddress",
      "value": "[e-mail]"
    }
  ],
  "identifierCount": 1,
  "attributes": {
    "emailaddress": [
      "[e-mail]"
    ],
    "firstName": "John",
    "initialReference": "32d6f4f9-7e9c-4271-bd83-9d6976808f2f",
    "lastName": "Doe",
    "timezone": "America/Sao_Paulo"
  },
  "listIds": [
    "12bd0e40-9361-4e32-8b26-99b4ab7eae09"
  ],
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z"
}