Skip to main content
POST
/
messages
/
sender_ids
Create a new Sender ID
curl --request POST \
  --url 'https://api.wavix.com/v1/messages/sender_ids?appid=' \
  --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": [
    "<string>"
  ],
  "usecase": "promo",
  "samples": [
    "Sample message 1",
    "Sample message 2"
  ]
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Body

application/json
​
sender_id
string
required

Name of the Sender ID. Can be either an alphanumeric string or a phone number on the account.

Example:

"Wavix"

​
type
enum<string>
required

Sender ID type

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

An array of 2 letter ISO codes of the countries the Sender ID to be allow listed in

​
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[]

Sample messages for the Sender ID

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

Response

​
id
string
required

Unique identifier of the Sender ID

Example:

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

​
sender_id
string
required

Name of the Sender ID. Can be either an alphanumeric string or a DID number.

Example:

"Wavix"

​
type
enum<string>
required

Sender ID type

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

An array of 2 letter ISO codes of the countries the Sender ID is allow listed in

​
usecase
string
Example:

"promo"

​
samples
string[]

Sample messages for the Sender ID

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