Messaging · SMS

Create an alphanumeric sender ID

Creates an alphanumeric sender ID.

POSThttps://api.pozy.ai/v1/sms/sender-ids
createSmsSenderId

Guides: Alphanumeric sender IDs, SMS

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • senderIdstringrequired

    3 to 11 characters.

Example

curl -X POST "https://api.pozy.ai/v1/sms/sender-ids" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "senderId": "68ef6f94df13738fb25f1e94"
}'

Response

200 on success

  • idstring
  • senderIdstring
  • isActiveboolean
200 response
{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "senderId": "68ef6f94df13738fb25f1e94",
  "isActive": true
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in SMS