Send Message

Send a message to a subscriber.

Body Params
string

The ID of the subscriber to send the message to. Either subscriber_id or phone is required.

string

The phone number of the subscriber to send the message to. The subscriber must exist. Either phone or subscriber_id is required. The phone number of the subscriber you want to send the message to.

string
Defaults to US

ISO Alpha-2 country code, used to parse phone more accurately.

string
required

The message body that you want to send to the subscriber.

string
enum
Defaults to promotional

The category of message you are sending.

Allowed:
date-time

ISO 8601 datetime to schedule delivery in the future. Default: null (deliver ASAP)

string

The URL of the media to send with the message. The media can be of type gif, png, and jpeg and will be formatted correctly on the recipient's device. The media size limit is 1MB for supported file types (JPEG, PNG, GIF) and 500KB for other types of accepted media. Please note that if you include a media url with your message, then it gets sent as an MMS message, which has different costs and character limits than SMS messages.

Headers
string

Shop API Token. Required for partners. This header should be used only by partners. Shops should include their API token in the Authorization header.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json