Skip to main content
POST
/
email
/
campaigns
/
{campaign}
/
submit
Submit an event to trigger a campaign
curl --request POST \
  --url http://localhost/public/v1/email/campaigns/{campaign}/submit \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "idempotency_key": "<string>"
}
'
{
  "ok": true
}

Path Parameters

​
campaign
string<uuid>
required

The campaign ID

Body

application/json
​
event_name
enum<string>
required

Required. The event name that triggers the campaign.

Available options:
contact.saved,
contact.unsubscribed,
lead.created,
sale.created
​
email
string<email> | null

Optional. Email address of the contact to trigger the campaign for.

​
idempotency_key
string | null

Optional. Idempotency key to identify the event.

Response

For now, acknowledge the submission. Actual dispatching is handled elsewhere.

​
ok
boolean
required