Create contact identifier

Error while loading OpenAPI operation — Invalid OpenAPI document

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": "[email protected]"
}'

Response (200 OK)

{
  "contactId": "12bd0e40-9361-4e32-8b26-99b4ab7eae09",
  "key": "emailaddress", 
  "value": "[email protected]",
  "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": "[email protected]",
  "properties": {
    "isGmail": true
  }
}'

Response (200 OK)

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