Skip to main content
POST
Identify a contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

At least one of externalUserId, email, phone, or anonymousId is required.

externalUserId
string

Your business identifier for the person (strongest matching key).

Example:

"user_123"

anonymousId
string

SDK anonymous visitor id, if known.

email
string<email>

Normalized (trim + lowercase) — the default dedup key.

Example:

"jane@acme.com"

phone
string

Used for matching only when confidently parseable as E.164.

Example:

"+33612345678"

firstName
string
lastName
string
source
string

Where the submission came from.

Example:

"website"

formId
string
Example:

"quote-form"

formType
string
Example:

"quote"

event
string

Optional business event emitted alongside system events.

Example:

"quote.requested"

traits
object

Arbitrary custom attributes (max 100 keys), merged per key.

Response

Submission accepted and queued for processing

ok
boolean
Example:

true

requestId
string<uuid>