Scheduling

One-time and recurring message schedules

Set scheduleType to once or recurring. Recurring schedules need a unit (minute, hour, day,week, month, year) and interval 1–1000.

requestPOST /messages/schedule

{
  "to": "+251911234567",
  "text": "Your weekly summary is ready.",
  "scheduleType": "recurring",
  "startsAt": "2026-08-11T09:00:00Z",
  "endsAt": "2026-12-31T23:59:59Z",
  "timezone": "Africa/Addis_Ababa",
  "recurrence": { "unit": "week", "interval": 1 }
}

responseJSON

{
  "id": "21ab90c4-5d6e-4789-a012-34567890abcd",
  "organizationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "active",
  "nextRunAt": "2026-08-11T09:00:00.000Z",
  "lastRunAt": null,
  "runCount": 0
}

Schedules start as active. Use PATCH /message-schedules/{scheduleId}/status with pause, resume, or cancel.