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.
Authorizations
Path parameters
workspaceIdstring · uuidRequiredExample:
Your workspace identifier.
b4e02c85-c6d2-4b15-8885-e09671799c61
contactIdstringRequiredExample:
The ID of a contact.
b4e02c85-c6d2-4b15-8885-e09671799c61
Body
keystring · min: 1 · max: 64RequiredExample:
The identifier key.
secondaryEmailAddress
Responses
201
The identifier was created successfully.
application/json
404
The contact or workspace was not found.
application/json
409
The HTTP could not be completed because of a conflict with the current state of the resource.
application/json
422
The HTTP request is well-formed but was unable to be processed. The HTTP response should include details about the error.
application/json
post
POST /workspaces/{workspaceId}/contacts/{contactId}/identifiers HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 118
{
"key": "secondaryEmailAddress",
"value": "[email protected]",
"properties": {
"countryCode": "US",
"isGmail": true
}
}
{
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"key": "secondaryEmailAddress",
"value": "[email protected]",
"properties": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"createdAt": "2025-06-22T18:46:35.687Z"
}
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.
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]"
}'
Create an identifier with properties
In this example, we're creating an identifier with custom properties.
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
}
}'
Last updated
Was this helpful?