WIwithallo
Partner

Create account

Changed on

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 and a Discounted licence (reseller) partner contract. The account gets its own Business plan subscription, billed to you at the chosen interval with your partner discount applied. The full period is charged when the account is created, with no proration: Allo draws on your prepaid credit first, then charges your card on file for the rest. Allo never charges your customer. This endpoint is optional: the partner portal (web.withallo.com/partner) creates accounts without code.

post/v2/api/partner/accounts

Request

  • Base URL
    https://api.withallo.com
  • URL
    https://api.withallo.com/v2/api/partner/accounts
  • Auth
    API key in header Authorization

Request body

emailstring required

Becomes the account's login.

namestring required
interval'MONTHLY' | 'YEARLY' required

Billing interval of the account's own subscription, billed to you.

personal_mobilestring nullable

Optional. An existing mobile the new number can attach 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",
  "interval": "MONTHLY",
  "personal_mobile": "+33612345678",
  "partner_client_ref": "crm-12345",
  "number_preference": {
    "country": "FR",
    "prefix": "+337"
  }
}

Response

Account created

Example response

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

Changes

  • 46c77103dd14Revision changes
    • breaking

      added the new required request property

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property /

    • info

      the request property became nullable

    • info

      the request property became optional