Skip to navigation

Identify users

View as Markdown
Legacy Tracker Documentation

For the legacy tracker doc, check our guide here.

This endpoint creates and updates users directly on the Brevo account.

You can identify a contact by email, or by passing an identifiers object with one or more supported keys. At least one of email or identifiers must be provided.

Identify by email

curl --request POST \
--url https://in-automate.brevo.com/api/v2/identify \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'ma-key: YOUR_MA_KEY' \
--data '
{
"email": "abc@brevo.com",
"attributes": {
"FIRSTNAME": "abc",
"LASTNAME": "def",
"Age": 24,
"SMS": "919989894562"
}
}
'

Identify by external ID (no email required)

curl --request POST \
--url https://in-automate.brevo.com/api/v2/identify \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'ma-key: YOUR_MA_KEY' \
--data '
{
"identifiers": {
"ext_id": "customer_98765"
},
"attributes": {
"FIRSTNAME": "Jane",
"LASTNAME": "Doe"
}
}
'

Parameters

AttributeDatatypeDescription
emailStringEmail address. Required unless identifiers is provided.
identifiersObjectContact identifiers. At least one key required if email is omitted. See supported keys below.
attributesObjectCustom fields. These user properties populate your contact database.

Supported identifiers

KeyTypeDescription
email_idStringEmail address (fallback for top-level email)
ext_idStringExternal identifier (e.g. CRM ID)
phone_idStringPhone number in international format
whatsapp_idStringWhatsApp number in international format
landline_number_idStringLandline number in international format

If both email and identifiers.email_id are provided, they must match — a mismatch returns 400.

Response

Response codeMessageDescription
204User has been identified and successfully updatedReturned on creation and update.
400Bad requestReturned for invalid_parameter, missing_parameter, or out_of_RangeModel errors.