scheduled_message

idinteger

schedule_typestring

once, weekly and monthly fire on scheduled_at. after_action fires when trigger_event happens instead, and ignores scheduled_at.

Possible values: [once, weekly, monthly, after_action]

statusstring

Possible values: [active, completed, canceled]

trigger_eventstring

Only read when schedule_type is after_action

Possible values: [conversation_resolved, conversation_created, conversation_reopened]

scheduled_atinteger

Unix timestamp of when the first step goes out

last_run_atinteger

Unix timestamp of the last time the sequence ran

conversation_idinteger

contact_idinteger

inbox_idinteger

created_atinteger

updated_atinteger

steps object[]

The messages of the sequence, in order

Array [

idinteger

contentstring

delay_secondsinteger

Wait after the previous step before sending this one

file_typestring

Type of the attached file, when the step carries one

file_namestring

file_urlstring

]

scheduled_message

{
  "id": 0,
  "schedule_type": "once",
  "status": "active",
  "trigger_event": "conversation_resolved",
  "scheduled_at": 0,
  "last_run_at": 0,
  "conversation_id": 0,
  "contact_id": 0,
  "inbox_id": 0,
  "created_at": 0,
  "updated_at": 0,
  "steps": [
    {
      "id": 0,
      "content": "string",
      "delay_seconds": 0,
      "file_type": "string",
      "file_name": "string",
      "file_url": "string"
    }
  ]
}