Send Message

API Details

  • For messaging without the use of campaigns, content and from are required.
    • If a campaignId for an SMS campaign is provided, the campaign's default content, sender number, and opt-in behavior are used unless overridden in the request (via content, from, or to.bypassOptIn). The message will be attributed to that campaign in reporting.
  • If a phoneNumber is provided that does not belong to an existing profile, a new profile will be created.

Rate Limit

Limit TypeValue
Requests per second250

If you exceed this limit, you will receive a 429 Rate Limit Exceeded response.

Body Params
number

Campaign to use as default message content, sender and metadata.

metadata
object

Optional metadata for tracking

string
enum
required

The messaging channel to use

Allowed:
to
object
required

Recipient information

from
object

Sender information

content
object

Message content. Overrides campaign defaults.

Responses

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