Check delivery key alias availability

GET

api

delivery-keys

alias

curl --request GET \
  --url https://convertly.sh/api/delivery-keys/alias \
  --header 'Authorization: Bearer <token>'

{
  "suggestions": [
    "<string>"
  ],
  "available": true
}

Authorization

string

header

required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

alias

string

Alias to check. Omit to receive an empty availability response.

Required string length: 3 - 63

Pattern: ^[a-z0-9][a-z0-9_-]*$

Alias availability result

suggestions

string[]

required

available

boolean | null

reason

enum<string>

Available options:

reserved,

invalid,

taken

Check delivery key alias availability

curl --request GET \
  --url https://convertly.sh/api/delivery-keys/alias \
  --header 'Authorization: Bearer <token>'

{
  "suggestions": [
    "<string>"
  ],
  "available": true
}