v6

latestOpenAPI 3.1.02026-08-03265555.4 KB

Campaigns

Receive Ehr Event Step

post/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}

Path parameters

campaign_idstring required

The ID of the campaign.

friendly_idstring required

The friendly ID of the step.

Request body

event_type'appointment_created' | 'appointment_cancelled' | 'patient_registered' required

event_dataobject

target_idstring nullable

Optional target ID.

external_idstring nullable

Optional external ID.

Response

Successful Response

{"stackTrail":"paths:/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}