Skip to main content
POST
Submit a named event

Authorizations

Authorization
string
header
required

Path Parameters

event_name
string
required

Body

application/json

Open map of fields submitted with an event. May include keys beyond those listed here. email is the primary identity key and the only field that enables profile merging. partner_user_id is a secondary lookup key and is not guaranteed unique.

email
string<email>

Primary identity key. The only data-map field that enables profile merging when submitted.

Example:

"user@example.com"

event_time
string<date-time>

ISO 8601 timestamp of when the event occurred. Optional; defaults to the time the request is received. Use for backdated events. On wrapped request bodies this is an alternative to the top-level event_time field.

Example:

"2024-01-15T12:00:00Z"

partner_user_id
string

Secondary lookup key for an existing profile. Not guaranteed unique across your program.

Example:

"usr_8392047156"

person_id
integer<int64>

Extole person identifier. Numeric. Submit to target an existing profile instead of resolving by email or partner user id.

Example:

7465313346145957000

Response

Event accepted and processed. Returns the assigned event_id and the resolved Extole person_id.

event_id
string
required

Unique identifier for the submitted event.

person_id
string
required

Extole person ID resolved from the event data.