Skip to main content
POST
Create account
Required scope: PARTNER
Creates an Allo account for one of your customers and provisions a phone number for it. The response returns a scoped API key for the new account (shown only once) alongside the provisioned number(s) and status.
  • number_preference.country is required (ISO country code, e.g. FR); number_preference.prefix is optional (e.g. +337).
  • A phone number is secured before the account is created — if none can be assigned or purchased, the request fails with NO_NUMBER_AVAILABLE and nothing is created.
  • The account is billed as one seat on your subscription; no charge is made to your customer.
  • If the email or personal mobile already belongs to an Allo account, the request fails with PARTNER_ACCOUNT_ALREADY_EXISTS.

Authorizations

Authorization
string
header
required

Body

application/json
email
string
required

Becomes the account's login.

name
string
required
Example:

"Jane Doe"

interval
enum<string>
required

Billing interval for the account's seat on your subscription.

Available options:
MONTHLY,
YEARLY
Example:

"MONTHLY"

number_preference
object
required
personal_mobile
string | null

Optional — an existing mobile the new number can attach to.

Example:

"+33612345678"

partner_client_ref
string

Your own reference for this customer. Echoed back and on the activation webhook.

Example:

"crm-12345"

Response

Account created

data
object