Senders

Senders are the sender names and virtual numbers your messages come from. See Senders for how sender names are approved.

Checking a name first

GET /v2/senders/availability?name={name} tells you whether a name can be requested, and why not if it can’t. Nothing is requested.

Requesting a sender

Send the name, an example of what you will send, and the countries to use it in:

{
  "name": "YourBrand",
  "sampleContent": "Hi Sam, your order has shipped and will arrive tomorrow.",
  "countries": ["GB", "IE"]
}

A sender name is 3 to 11 letters, numbers, underscores or spaces. Our team reviews it, and its status is pending until then.
A UK mobile number starting 07 is sent a code by SMS instead. Its status is awaiting_verification until you send the code to POST /v2/senders/{id}/verify.

countries are ISO 3166-1 alpha-2 codes, and default to your workspace’s country. Requesting a sender you already have returns it with 200 OK, with any new countries added.

API reference: POST /v2/senders

Cancelling a request

DELETE /v2/senders/{id} cancels a request that is still pending. Approved senders, and senders already used to send messages, can’t be removed this way.