Skip to main content
POST
cURL
Requires a prior event route (POST /api/v1/event-routes or API Access → Event routes). Unknown eventType → 422 event_unmapped. Same optional template fields as create-lead: emailTemplateId, whatsappTemplateId, templateVariables, whatsappParams, per-channel clocks. List ids via List Omni templates.

Authorizations

Authorization
string
header
required

Paste only your API key (ond_live_… or ond_test_…). Do not type the word Bearer - the playground adds it.

Headers

Idempotency-Key
string

Body

application/json
eventType
string
required
Example:

"lead.created"

phone
string
required
name
string
email
string
channels
string[]
scheduledAt
string<date-time>
emailScheduledAt
string<date-time>
whatsappScheduledAt
string<date-time>
emailTemplateId
string
emailProfileId
string
whatsappTemplateId
string
whatsappProfileId
string
metadata
object

Response

Routed and accepted

leadId

Your own lead id, exactly as you sent it. Omitted when you did not send one.

Maximum string length: 200
Example:

177

contactId
string
campaignId
string
channels
string[]
status
string
mode
enum<string>
Available options:
live,
sandbox
reasonCode
string
scheduledAt
string<date-time> | null
emailScheduledAt
string<date-time> | null
whatsappScheduledAt
string<date-time> | null
emailTemplateId
string | null
emailProfileId
string | null
whatsappTemplateId
string | null
whatsappProfileId
string | null
templateVariables
object | null
whatsappParams
string[] | null