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.
intervalis required:MONTHLYorYEARLY. It sets the billing interval of the account's subscription.number_preference.countryis required (ISO country code, e.g.FR);number_preference.prefixis optional (e.g.+337).number_preference.esimis optional,falseby default. Set it totrueto get a French mobile number that can carry an eSIM, which you then order with Order eSIM. eSIM numbers are only available in France: with anycountryother thanFR, the request fails withESIM_NOT_AVAILABLE_IN_COUNTRY.prefixstill applies, for example7or+337.- A phone number is secured before the account is created. If none can be assigned or purchased, the request fails with
NO_NUMBER_AVAILABLEand nothing is created. - The account gets its own Business plan subscription, billed to you with your partner discount applied. The full period is charged when the account is created. No charge is made to your customer. Call Get account price first to see the amount.
- Allo draws on your prepaid credit first, then charges your card on file for the rest.
- If your prepaid credit does not cover the first period and you have no card on file, the request fails with
402 PARTNER_CREDIT_INSUFFICIENTand nothing is created. - If your card is declined, the request fails with
402 PARTNER_BILLING_FAILEDand nothing is created. - If the email or personal mobile already belongs to an Allo account, the request fails with
PARTNER_ACCOUNT_ALREADY_EXISTS. - If your account is not an enabled partner, the request fails with
PARTNER_ACCESS_REQUIRED. If your partner contract cannot create accounts, it fails withPARTNER_CONTRACT_CANNOT_PROVISION. Only Discounted licence (reseller) partners can create accounts.
The partner portal creates accounts the same way, without code.
Numbers and teammates are then added in the Allo app. White-label partners add them from the API with Add number and Add member.
The account's API key
The api_key in the response acts on the new account, not on yours. Store it right away: Allo returns it only once, and GET /v2/api/partner/accounts/{id} does not return it again. The key has these 14 scopes:
| Scope | What the key can do on the account |
|---|---|
CRM_READ | Get and search people, companies and deals, and list custom fields |
CRM_WRITE | Create and update people and companies, and create custom fields |
WEBHOOKS_READ_WRITE | Create and manage the account's webhook endpoints |
CONVERSATIONS_READ | Read the account's calls, SMS, transcripts and summaries |
PHONE_NUMBERS_READ | List the account's numbers, and read a number's published call flow and its draft |
PHONE_NUMBERS_WRITE | Save and publish a number's call flow draft. The key cannot buy or release numbers |
AGENTS_READ | Read a number's AI receptionist, and list the connected calendars and the available voices |
AGENTS_WRITE | Configure the AI receptionist: its settings, its prompt, turning it on or off, and its knowledge (add, update and remove websites, remove files) |
SUMMARY_TEMPLATES_READ | List and read the account's call summary templates |
SUMMARY_TEMPLATES_WRITE | Create, update and delete summary templates, and set a number's default template with PUT /v2/api/numbers/{number}/default_summary_template |
TAGS_READ | List the account's tags with GET /v2/api/tags |
TAGS_WRITE | Create and delete tags, and add or remove a tag on a call with POST and DELETE /v2/api/conversations/items/{id}/tags |
USERS_READ | List the account's members, and get one, with GET /v2/api/users |
SMS_SEND | Send an SMS with POST /v1/api/sms |
French regulation forbids automated SMS from a mobile number, so sending from the account's French mobile number fails with A2P_NOT_ENABLED. Send from a validated sender ID instead, with the sender_id parameter.
Keys issued before these scopes were added receive them automatically. The secret does not change, so you have nothing to update.
See API key scopes for the endpoints each scope covers.