Events (journeys)
Tell the panel something happened in your system — a booking, a cancellation. Every journey switched on for that event sends its utility templates at the set times. Journeys that are off send nothing, now or later.
Base address: https://app.ezreach.in/api/v1
Report an event
events:writeIdempotency-KeyStarts the journeys listening for this event name, for one person (to + key) or up to 500 (people[]).
Body
eventrequiredstring
The event name a journey listens for, e.g. rsvp.confirmed.
keyrequiredstring
Your id for this booking. The same key again is the same booking (nothing is sent twice).
torequiredstring
The person's WhatsApp number (E.164).
groupstring
Your id for the thing booked, to cancel or move everybody at once.
atISO date
When it starts. Required when a journey has steps before it starts or after it ends.
endsAtISO date
When it ends (else 3 hours after it starts).
dataRecord<string, string>
Values for the templates' blanks, e.g. event_name, when, where (≤ 30 keys).
people{ to, key, contact?, data?, optInEvidence? }[]
Instead of to + key: up to 500 people at once.
optInEvidencestring
Only for a person the panel does not know yet: how they agreed to offers (≤ 200 characters). They then start Subscribed. Without it a new person starts on “No offers”: updates about their booking only.
accountIdstring
The WhatsApp number to send from, when the journey is set to all numbers (else the default number). A journey set to one number always uses it.
Request
curl -X POST "https://app.ezreach.in/api/v1/events" \
-H "Authorization: Bearer $EZREACH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event": "rsvp.confirmed",
"key": "rsvp_8812",
"group": "event_7e3c",
"to": "+919876543210",
"contact": {
"name": "Rohan"
},
"at": "2026-09-27T17:00:00+05:30",
"endsAt": "2026-09-27T20:00:00+05:30",
"data": {
"event_name": "Traitors - Trust no one",
"when": "Sat, 27 Sep at 5:00 PM",
"where": "DLF Phase 1, Gurugram"
}
}'Response
{
"data": {
"accepted": true,
"journeys": [
{
"automationId": "cm4j0urn3y0001",
"name": "Event booking journey",
"people": 1,
"steps": [
{
"index": 0,
"label": "Right away",
"dueAt": "2026-09-25T10:00:00.000Z",
"status": "PENDING"
},
{
"index": 1,
"label": "24 hours before it starts",
"dueAt": "2026-09-26T11:30:00.000Z",
"status": "PENDING"
}
]
}
],
"ignored": [],
"duplicates": 0,
"invalid": []
}
}Errors
- 422
EVENT_TIME_REQUIREDA journey has timed steps and no
atwas sent. - 422
ACCOUNT_MISMATCHaccountId names another number than the one the journey sends from. Nothing is stored.
- 503
RESTART_NEEDEDThe panel must be restarted after its last update before journeys work.
- A reminder is never sent late: a step whose time has passed (booked too late, or the panel was offline) is skipped with its reason.
- Timed steps are kept out of 10 pm to 8 am (workspace time) unless the journey step says otherwise: a reminder moves to 9 pm the evening before (or 8 am when that has passed and is still before the start); a feedback message waits for 8 am.
- A person the panel does not know yet is added on “No offers” (updates about their booking, never campaigns), unless you send optInEvidence. An existing contact's choice is never changed by a booking.
- With no journey switched on for the event, the answer is 200 with journeys: [] and a note. Nothing is sent.
Cancel a booking or an event
events:writeSteps not sent yet become cancelled. Send exactly one of key or group.
Body
keystring
One booking.
groupstring
Everybody booked for one event.
reasonstring
Shown on the journey's bookings.
Request
curl -X POST "https://app.ezreach.in/api/v1/events/cancel" \
-H "Authorization: Bearer $EZREACH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"group": "event_7e3c",
"reason": "Event cancelled by the host"
}'Response
{
"data": {
"cancelled": 12
}
}Move a booking or an event
events:writeSteps not sent yet get new times; a step whose new time has already passed is skipped ("rescheduled into the past").
Body
keystring
One booking.
groupstring
Everybody booked for one event.
atrequiredISO date
The new start.
endsAtISO date
The new end.
dataRecord<string, string>
Merged into the booking's values (e.g. a new "when").
Request
curl -X POST "https://app.ezreach.in/api/v1/events/reschedule" \
-H "Authorization: Bearer $EZREACH_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"group": "event_7e3c",
"at": "2026-09-28T17:00:00+05:30",
"data": {
"when": "Sun, 28 Sep at 5:00 PM"
}
}'Response
{
"data": {
"moved": 11,
"skipped": 1
}
}Look up a booking
events:readEvery journey step of one booking and what happened to it (reached, read, failed, awaiting confirmation).
Path parameters
keyrequiredstring
Your booking key.
Request
curl "https://app.ezreach.in/api/v1/events/rsvp_8812" \
-H "Authorization: Bearer $EZREACH_API_KEY"Response
{
"data": {
"key": "rsvp_8812",
"group": "event_7e3c",
"contact": {
"phone": "+919876543210",
"name": "Rohan"
},
"journeys": [
{
"name": "Event booking journey",
"steps": [
{
"index": 0,
"label": "Right away",
"status": "SENT",
"delivery": "read"
}
]
}
]
}
}
