Submit a named event

post

https://api.extole.io/v6/events/{event_name}

Submits a specific named consumer event synchronously. The event name is supplied in the URL path rather than in the request body, and the body is an open data map.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

event_name

string

required

Body Params

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.

string

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

event_time

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_id

string

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

person_id

int64

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

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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

400Bad request. The named examples below cover this operation's specific validation errors. Other 400 causes include malformed JSON, an invalid Time-Zone header, and an empty request body - inspect the response code field for the specific error.

401Unauthorized

402Payment Required

403Forbidden

415Unsupported Media Type

429Too Many Requests