Skip to content
Aureus PrimeDocs

Guides

Schedule an SMS

Add scheduledAt to the request to choose the sending date and time, up to 30 days ahead.

curl -X POST https://api.getaureusdesk.com/v1/sms/messages \
  -H "Authorization: Bearer adk_sms_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to": "699123456", "text": "Reminder: your appointment is tomorrow at 10 am.", "scheduledAt": "2026-11-02T08:00:00+01:00"}'

Rules

  • Format: ISO 8601 date with a time zone: 2026-11-02T08:00:00+01:00 (Cameroon time) or 2026-11-02T07:00:00Z. Without a time zone: rejected.
  • In the future, and 30 days at most after the call. Otherwise: 422 SCHEDULE_INVALID.
  • Credits reserved as soon as the SMS is scheduled.
  • The SMS stays in QUEUED status until its date, then goes out like the others. The response and GET /sms/messages/:id return scheduledAt.
  • A 2-SMS message (allowTwoParts) can be scheduled: part 1 goes out on the chosen date, part 2 after it is delivered.

Cancel a scheduled SMS

DELETE https://api.getaureusdesk.com/v1/sms/messages/:id

As long as the SMS has not gone out, it moves to CANCELLED and its credits are given back to you. For a 2-SMS message, the cancellation covers both parts. 200 response with the state of the message.

Code Case
409 NOT_CANCELLABLE The SMS was not scheduled, or it has already gone out
404 NOT_FOUND The message does not belong to your account

Tip

For a one-time code, do not use scheduling: send it right away with "sensitive": true.