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.

POSThttps://api.bird.com/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

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

contactId*string

The ID of a contact.

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

Body

application/json

key*Contacts_identifierKey (string)

The identifier key.

Example: "secondaryEmailAddress"

value*Contacts_identifierValue (string)

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.

Response

201404409422

The identifier was created successfully.

Body

application/json

contactId*string (uuid)

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

key*string

Example: "secondaryEmailAddress"

value*string

Example: "[e-mail]"

propertiesobject

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/contacts/{contactId}/identifiers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "secondaryEmailAddress",
      "value": "[e-mail]"
    }),
});
const data = await response.json();

Response

201404409422

{
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "key": "secondaryEmailAddress",
  "value": "[e-mail]",
  "createdAt": "2024-12-03T15:14:24.625Z"
}

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