For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create an Event

Create new event

post

Create a new event for a contact. To identify the contact, use either user_id, or email & firstname or phone & firstname

Header parameters
X-API-KEYstringRequired

Your API key

X-SECRET-KEYstringRequired

Your Secret key

Body
app_idstringRequired
_idstringOptional
user_idstringRequired
emailstringOptional
phonestringOptional
event_typestringRequired
event_namestringOptional
event_datestring · dateRequired

Date of the event in YYYY-MM-DD format

event_timestring · timeOptional

Time of the event in HH:MM AM/PM format

idstringRequired

Unique Event ID from your system

is_visitbooleanOptional
is_purchasebooleanOptional
event_dataobject[]Optional

Event data with custom fields such as status, staff etc.

Example: {"status":"completed","staff":"John Doe"}
Responses
200

Event created successfully

application/json
resultstringOptionalExample: success
post
/v2/ExternalApi/newEvent

Last updated