v1

latestOpenAPI 3.0.32026-07-264955102.7 KB

Partner

Create account

Creates an Allo account for one of your customers, provisions a phone number, and returns a scoped API key for the account. Requires the PARTNER scope. The account is billed as one seat on your subscription.

post/v2/api/partner/accounts

Request body

emailstring required

Becomes the account's login.

namestring required

personal_mobilestring required

Mandatory — an existing mobile the secondary number attaches to.

partner_client_refstring

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

Example request

{
  "email": "client@example.com",
  "name": "Jane Doe",
  "personal_mobile": "+33612345678",
  "partner_client_ref": "crm-12345",
  "number_preference": {
    "country": "FR",
    "prefix": "+337"
  }
}

Response

Account created

Example response

{
  "data": {
    "id": "usr_2Nf...",
    "api_key": "b1c2...",
    "phone_numbers": [
      "+33712345678"
    ],
    "status": "ACTIVE",
    "partner_client_ref": "crm-12345"
  }
}