Skip to main content
POST
Request a sender

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Body

application/json
value
string
required

A brand name of 3 to 11 letters and digits (single spaces allowed), or a number of 6 to 15 digits you own.

Example:

"AcmeShop"

useCase
string
required

What you send from it; kept for the network application.

Required string length: 20 - 1000
countries
string[]

ISO 3166-1 alpha-2 countries it should be used in. Defaults to the countries your organisation enabled.

Response

Requested

id
string
required
Example:

"sdr_01j9x7k2r4m8q3v5n6b7c8d9e0"

value
string
required

As the networks show it; name it on a send as senderId once approved.

Example:

"AcmeShop"

kind
enum<string>
required
Available options:
numeric,
alphanumeric
status
enum<string>
required

requested = being registered with the networks; approved = usable; rejected = could not be registered (see reviewNote); revoked = no longer usable.

Available options:
requested,
approved,
rejected,
revoked
isDefault
boolean
required

Used when a send names no sender. At most one per organisation.

useCase
string
required
countries
string[]
required
Example:
caveats
string[]
required

What the networks do with this kind of sender in those countries, in plain language.

reviewNote
string | null
required

The reviewer's note: why it was rejected or revoked, or how it was registered.

requestedAt
string<date-time>
required
reviewedAt
string<date-time> | null
required