Create a contact
POST
/v1/contacts
curl -X POST "https://us1.platform.bird.com/v1/contacts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "alice@acme.com",
"first_name": "Alice",
"last_name": "Anderson"
}'Creates a contact in the workspace. Contacts are unique by email address; creating a second contact with the same email returns a conflict error. The same applies to external_id — a value already used by another contact returns a conflict error. Custom values in data must use property keys you created via the contact properties API, with values matching each property's declared type.
Corps de la requête
email
string
obligatoire
The contact's email address. Trimmed and lowercased before it is stored and checked for uniqueness. Unique within the workspace.
first_name
string
The contact's first name.
last_name
string
The contact's last name.
external_id
string
Your own identifier for this contact, such as a user ID in your system. Unique within the workspace when set.
data
object
Custom property values for this contact. Each key must be a property created via the contact properties API, and each value must be a string, number, or boolean matching the property's declared type (strings up to 500 characters); a null value is ignored. Total size is capped at 2 KB serialized.
Contenu de la réponse
id
string
obligatoire
Contact ID.
email
string
obligatoire
The contact's email address, stored trimmed and lowercased. Unique within the workspace.
first_name
nullable string
The contact's first name.
last_name
nullable string
The contact's last name.
external_id
nullable string
Your own identifier for this contact, such as a user ID in your system. Unique within the workspace when set.
data
object
Custom property values for this contact, available as template variables in broadcasts. Each key is a property created via the contact properties API, and each value is a string, number, or boolean matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized.
created_at
string
obligatoire
updated_at
string
obligatoire