Skip to main content
POST
Declare sender ID
Required scope: PARTNER
Declares an alphanumeric sender ID on one of your accounts, so the account can send SMS under its brand name instead of a phone number. In France, automated SMS cannot be sent from mobile numbers, so a sender ID is how your software texts the account’s customers. The response returns the sender ID with status PENDING.

Request

  • sender_id is required: 1 to 11 letters or digits, with no spaces or symbols, for example PLOMBMARTIN. A missing value fails with MISSING_FIELD, any other format with SENDER_ID_INVALID_FORMAT. The name has to represent the account’s actual business, see the Sender ID naming rules.
  • example_content is optional: an example of a message the account will send, up to 1,000 characters. Allo’s reviewer reads it. A longer value fails with EXAMPLE_CONTENT_TOO_LONG.

Rules

  • A sender ID belongs to one Allo account only. A name already held by another Allo account fails with 409 SENDER_ID_ALREADY_EXISTS.
  • An account holds at most 3 sender IDs. A fourth fails with 409 MAX_SENDER_IDS_REACHED.
  • Sending the same sender_id again for the same account returns the existing sender ID, so a retry is safe.
  • You can only declare sender IDs on accounts your own API key created. Any other account returns 404 PARTNER_ACCOUNT_NOT_FOUND.

Review

Allo reviews every sender ID by hand, usually in 1 to 5 business days. When the review ends, Allo sends partner.sender_id.validated or partner.sender_id.failed to your own webhook endpoint. Without a webhook endpoint, poll Get sender ID. Once the sender ID is VALIDATED, the account sends SMS with it through Send SMS (France).

Authorizations

Authorization
string
header
required

Path Parameters

account_id
string
required

The account id returned by Create account (usr-*).

Body

application/json
sender_id
string
required

1 to 11 letters or digits, with no spaces or symbols. It must not belong to another Allo account.

Required string length: 1 - 11
Example:

"PLOMBMARTIN"

example_content
string | null

Optional. An example of a message the account will send, shown to the Allo reviewer.

Maximum string length: 1000
Example:

"Bonjour, votre intervention est confirmée demain à 9h. Plomberie Martin"

Response

Sender ID declared, waiting for Allo's review

data
object

An alphanumeric sender ID declared on an account you provisioned.