Inbox

Send an SMS notification

Sends an SMS message to a clinic client on behalf of a clinic.

Important limitations:

  • Message length: Individual carriers impose their own limits on message length, and these limits can change over time. Messages that exceed a carrier's limit may be split, truncated, or outright rejected.
  • Rate limits: SMS sending is subject to overall, per-carrier, and daily rate limits. These limits are shared across all messages sent from your clinics — including messages sent by Vetcove on your behalf through other features in our platform. This endpoint enforces a limit of 20 requests per second and 200,000 requests per day per organization. These limits are not per carrier, so if your messages are not well distributed across carriers it is possible to stay within our limits while still exceeding the per-carrier limits of our third-party SMS provider.
  • Trust score: Your organization is assigned a trust score by the underlying SMS provider. The content and volume of messages you send directly affects this score. Sending spammy, inappropriate, or excessive messages can lower your score, resulting in stricter rate limits and reduced deliverability across all of your clinic communications.
post/ext/v2/sms-notifications/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/sms-notifications/
  • Auth
    HTTP bearer

Request body

bodystring required

The SMS message body.

clinic_client_idinteger required

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

Response

Created

bodystring required

The SMS message body.

client_communication_number_idinteger required

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

clinic_client_idinteger required

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

clinic_idinteger required

The ID of the clinic the SMS was sent from.

created_atstring date-time required

When the SMS notification was created.

error_codestring nullable required

Error code from the SMS provider if sending failed.

error_reasonstring nullable required

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

idinteger required

The ID of the SMS notification.

status'SENT' | 'DELIVERED' | 'FAILED_TO_SEND' required

Delivery status of an SMS notification sent via the Connect API.

Changes

No recorded changes to this operation across all 1 revision of this API.