API Reference
Privacy & SecuritySupport CenterLog In

Send Message

post
https://api.regal.ai/v1/messages/send

Send messages at scale.

Rate Limit

Limit TypeValue
Requests per second10

If you exceed these limits, you will receive a 429 Rate Limit Exceeded response.

API Details

  • For messaging without the use of campaigns, content and from are required.
    • If a campaignIdfor 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.

Body Params
to
object
required

The message recipient.

from
object

The message sender.

string
enum
required

The communication channel.

Allowed:
content
object

The message content.

int32

If an SMS campaign is provided, the campaign supplies default content, from number, and opt-in behavior. Any values included in the request (via content, from, or to.bypassOptIn) override the campaign defaults.

Headers
string
required

Your Regal API Key

string
required
Defaults to application/json
Responses

Updated about 2 months ago

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