/v1/participants/{id}/auto_messages

Queues or un-queues a single automated message for a participant. Pass the participant id in the path and identify the message with message_id (from the list endpoint).

• Set queued to true to schedule the message to send automatically at its configured time.
• Set queued to false to cancel a scheduled message so it will not send.

{
  message_id: 5,
  queued: true
}

A message can only be queued when it has an applicable send time for the participant. If it does not, the request is rejected with a 422 response.

The affected message is returned in the same shape as the list endpoint:

{
  auto_message: {
    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: true,
    reminder_state: "initial"
  }
}

To send a message immediately instead of scheduling it, use /v1/start_conversation with an auto_message_id.

OAuth scope

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