Skip to main content
POST
/
v3
/
messages
/
sender-ids
Create a Sender ID
curl --request POST \
  --url https://api.wavix.com/v3/messages/sender-ids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_id": "Wavix",
  "type": "numeric",
  "countries": [
    "<string>"
  ],
  "usecase": "transactional",
  "monthly_volume": "1001-20000",
  "samples": [
    "Sample message 1",
    "Sample message 2"
  ]
}
'
{
  "id": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c",
  "sender_id": "Wavix",
  "type": "numeric",
  "allowlisted_in": [
    "example"
  ],
  "usecase": "example",
  "samples": [
    "example"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token using appid (Authorization: Bearer )

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

Sender ID type.

Available options:
numeric,
alphanumeric
​
countries
string[]
required

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

​
usecase
enum<string>
required

Use case for the Sender ID

Available options:
transactional,
promo,
authentication
Example:

"transactional"

​
monthly_volume
enum<string>

Expected monthly volume.

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

"1001-20000"

​
samples
string[]

Message samples.

Example:
["Sample message 1", "Sample message 2"]

Response

Sender ID created.

​
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

Sender ID type.

Available options:
numeric,
alphanumeric
​
allowlisted_in
string[]
required

List of countries where the Sender ID is allowlisted.

​
usecase
string
Example:

"promo"

​
samples
string[]

Message samples.

Example:
["Sample message 1", "Sample message 2"]