GEgetprosperapp
Campaigns

Receive Ehr Event Step

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

Request

  • Base URL
    https://voice.getprosperapp.com (the document declares no server; this is the origin it was published from)
  • URL
    https://voice.getprosperapp.com/api/v1/campaigns/{campaign_id}/ehr-event/{friendly_id}
  • Auth
    none declared

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

unknown required

Changes

No recorded changes to this operation across all 25 revisions of this API.