Skip to Content
Smart Reminders

Schedule multi-stage appointment reminder

View Markdown (.md)
POST
/api/v1/public/reminders/schedule

Queues automated timed reminders before an event (e.g. 24h, 2h before). Charges SMS segment cost plus configured service surcharge per sent stage.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Request Body

application/json
  1. body
recipient*string
eventTitle*string
eventTime*string
Formatdate-time
schedule*array<string>
messageTemplate*string
senderId?string

Response Body

Reminder successfully scheduled

application/json
  1. response
status?string
message?string
data?
Example Request
curl -X POST 'https://api.smspro.com/api/v1/public/reminders/schedule' \  -H 'Content-Type: application/json' \  -d '{  "recipient": "string",  "eventTitle": "string",  "eventTime": "2019-08-24T14:15:22Z",  "schedule": [    "string"  ],  "messageTemplate": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "recipientPhone": "string",    "senderId": "string",    "eventTitle": "string",    "eventTime": "2019-08-24T14:15:22Z",    "status": "string",    "stages": [      {        "offset": "string",        "status": "string",        "dispatchedAt": "2019-08-24T14:15:22Z"      }    ]  }}