Skip to main content
POST
Send an SMS notification

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Schema for creating an SMS notification via the Connect API.

body
string
required

The SMS message body.

Required string length: 1 - 1600
clinic_client_id
integer
required

The ID of the clinic client to send the SMS to.

Response

Created

body
string
required

The SMS message body.

client_communication_number_id
integer
required

The ID of the client communication number the SMS was sent to.

clinic_client_id
integer
required

The ID of the clinic client the SMS was sent to.

clinic_id
integer
required

The ID of the clinic the SMS was sent from.

created_at
string<date-time>
required

When the SMS notification was created.

error_code
string | null
required

Error code from the SMS provider if sending failed.

error_reason
string | null
required

Human-readable reason for the error, if the error code is recognized.

id
integer
required

The ID of the SMS notification.

status
enum<string>
required

The delivery status of the SMS.

  • SENT: Message was sent but delivery is not yet confirmed.
  • DELIVERED: Message was successfully delivered.
  • FAILED_TO_SEND: Message failed to send.
Available options:
SENT,
DELIVERED,
FAILED_TO_SEND