Create contact identifier

Create contact identifier

This endpoint is used to create a new identifier for a contact. The identifier will be added to the contact and can be used for different purposes such as targeting, mapping, and more.

post

/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidrequired

Your workspace identifier.

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

contactIdstringrequired

The ID of a contact.

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

Body

keystring · min: 1 · max: 64required

The identifier key.

Example: secondaryEmailAddress

valuestring · min: 1 · max: 500required

The identifier value.

Example: [e-mail]

propertiesobject

Object with key-value pairs, where the key is up to 64 characters, only letters and digits. This can be used to store additional information about the identifier.

Example: {"countryCode":"US","isGmail":true}

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/{contactId}/identifiers' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "secondaryEmailAddress",
    "value": "[e-mail]",
    "properties": {
      "countryCode": "US",
      "isGmail": true
    }
  }'

201

404

409

422

201

{
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "key": "secondaryEmailAddress",
  "value": "[e-mail]",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2025-02-28T01:38:06.529Z"
}

The identifier 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

• Contact ID: 12bd0e40-9361-4e32-8b26-99b4ab7eae09

Create an identifier without properties

In this example, we're creating an identifier without custom properties.

Request

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

Response (200 OK)

{
  "contactId": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "key": "emailaddress", 
  "value": "[e-mail]",
  "properties": {
    "isGmail": true
  },
  "createdAt": "2024-11-26T15:00:00.000Z"
}

Create an identifier with properties

In this example, we're creating an identifier with custom properties.

Request

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

Response (200 OK)

{
  "contactId": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "key": "emailaddress", 
  "value": "[e-mail]",
  "properties": {
    "isGmail": true
  },
  "createdAt": "2024-11-26T15:00:00.000Z"
}