Skip to main content
POST
Create a Sender ID

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Body

application/json
sender_id
string
required

Sender ID name. Can be either an alphanumeric string or a phone number.

Example:

"Wavix"

type
enum<string>
required

Format of the Sender ID. One of numeric (a phone number) or alphanumeric (a text sender name).

Available options:
numeric,
alphanumeric
countries
string[]
required

Two-letter ISO country codes where the Sender ID is allowlisted.

usecase
enum<string>
required

Primary use case for the Sender ID. One of transactional (account or order notifications), promo (marketing and promotional messages), or authentication (one-time passcodes and verification codes).

Available options:
transactional,
promo,
authentication
Example:

"transactional"

monthly_volume
enum<string>

Expected number of messages sent per month from the Sender ID. One of 1-1000, 1001-20000, 20001-50000, 50001-100000, or More than 100000. Each value is the message-count band for the month.

Available options:
1-1000,
1001-20000,
20001-50000,
50001-100000,
More than 100000
Example:

"1001-20000"

samples
string[]

Message samples.

Example:

Response

Returns the created Sender ID.

id
string
required

Sender ID ID.

Example:

"3c7a5a90-43e0-43e0-b006-fdfea30c5a7c"

sender_id
string
required

Sender ID name.

Example:

"Wavix"

type
enum<string>
required

Format of the Sender ID. One of numeric (a phone number) or alphanumeric (a text sender name).

Available options:
numeric,
alphanumeric
allowlisted_in
string[]
required

List of countries where the Sender ID is allowlisted.

usecase
string

Primary use case declared for the Sender ID, such as transactional, promo, or authentication.

Example:

"promo"

samples
string[]

Message samples.

Example: