/v1/participants/{id}/auto_messages

Lists the automated reminder messages from a participant's applicable schedule, evaluated for that participant. Use this to see which messages apply, when they would fire, and whether they are currently queued to send.

Pass the participant id in the path, e.g. GET /v1/participants/789/auto_messages.

Example Result:

{
  auto_messages: [ {
    id: 5,
    name: "Text Reminder",
    comm_type: "sms",
    content: "Appt Reminder: {{event.day_and_time_phrase}} ...",
    enabled: true,
    matches: true,
    send_time: "2016-04-15T09:00:00-07:00",
    queued: false,
    reminder_state: null
  }]
}

Field meanings:

• comm_type - the channel the message is sent on: sms, call, or email.
• matches - whether the message applies to this participant.
• send_time - when the message would fire for this participant, or null if it has no applicable time.
• queued - true when the message is currently scheduled to send at its configured time.
• reminder_state - the state of the underlying reminder when one exists (e.g. initial for a scheduled message, sent once it has been sent), or null when none exists.

To queue or un-queue a message, use the PUT form of this endpoint. To send a message immediately, use /v1/start_conversation with an auto_message_id.

OAuth scope

Calls authenticated with an OAuth 2.0 bearer token must include the events:read scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.