v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Events

Submit a named event asynchronously

Submits a specific named consumer event asynchronously. The event name is supplied in the URL path and the body is an open data map. No per-request rate limit. Returns event_id only; person identification occurs asynchronously.

post/v6/async-events/{event_name}

Path parameters

event_namestring required

Request body

emailstring email

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

event_timestring 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.

partner_user_idstring

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

person_idinteger

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

Example request

{
  "email": "user@example.com",
  "event_time": "2024-01-15T12:00:00Z",
  "partner_user_id": "usr_8392047156",
  "person_id": 7465313346145957000
}

Response

Event accepted and queued for asynchronous processing. Returns the assigned event_id. Person identification completes after the response is returned.

event_idstring required

Unique identifier for the queued event. Person identification occurs asynchronously after the request returns.