v1

latestOpenAPI 3.0.02026-08-067074272.5 KB

Scheduled Messages

Retrieves a scheduled 1:1 message.

Returns details for a single scheduled 1:1 message, including dashboard from number and recipient_name. Group scheduled messages are not returned by this endpoint.

get/dashboards/{dashboard_id}/scheduledmessages/{message_id}

Path parameters

dashboard_idinteger required

Example:121

Id of dashboard

message_idstring uuid required

Example:eb2a0cc2-5b88-468b-b3f4-926b07bcb275

The scheduled message's unique identifier (message_id returned when the message was scheduled).

Response

The scheduled message details.

message_idstring uuid

The scheduled message's unique identifier.

status'scheduled'

Scheduled message status.

bodystring

The message body.

tostring

The recipient phone number.

date_createdstring date-time

UTC timestamp when the scheduled message was created.

schedule_date_utcstring date-time

UTC timestamp of the next scheduled send.

occurrence_numberinteger

For recurring messages, which occurrence is next. Omitted for non-recurring messages.

mms_mediastring[]

MMS media URLs attached to this message.

Field	Rule
repeat_by	Required. Must be day, week, month, or year (plural forms days, weeks, months, years are also accepted).
step	Required. Must be an integer ≥ 1. See Understanding step below.
schedule_date_utc	Required on the parent request whenever repeat_settings is present. Must be a future UTC timestamp for the first send.

step	repeat_by	Meaning
1	day	Every day
2	day	Every 2 days
3	day	Every 3 days
14	day	Every 14 days
1	week	Every week
2	week	Every 2 weeks (biweekly)
4	week	Every 4 weeks
1	month	Every month (same day of month as schedule_date_utc)
2	month	Every 2 months
3	month	Every 3 months (quarterly)
1	year	Every year (same month/day as schedule_date_utc)
2	year	Every 2 years

Field	Rule
times	Stop after this many total sends (including the first).
end_date	Stop after this UTC date. Must be in the future.
(neither)	The series repeats until you cancel it.

repeat_by	Meaning (N = step)	Extra fields
day	Repeats every N day(s)	—
week	Repeats every N week(s)	Optional days array for specific weekdays
month	Repeats every N month(s) on the same day of month as schedule_date_utc	—
year	Repeats every N year(s) on the same month/day as schedule_date_utc	—

fromstring

The dashboard phone number the message will be sent from.

recipient_namestring

The contact's display name, if known.

Example response

{
  "message_id": "eb2a0cc2-5b88-468b-b3f4-926b07bcb275",
  "status": "scheduled",
  "body": "Reminder: your appointment is tomorrow.",
  "to": "14239309346",
  "date_created": "2026-08-01T12:00:00Z",
  "schedule_date_utc": "2026-08-15T14:00:00Z",
  "occurrence_number": 1,
  "repeat_settings": {
    "repeat_by": "week",
    "step": 1,
    "times": 5,
    "end_date": "2026-12-31T23:59:59Z",
    "days": [
      "Monday",
      "Wednesday"
    ]
  },
  "from": "14232180111",
  "recipient_name": "Bruce Wayne"
}

v1

Retrieves a scheduled 1:1 message.

Path parameters

Response

Required fields

Understanding step

Optional stop conditions (pick one or neither)

Repeat mode reference

Not allowed

Example response