WIwithallo
Partner

Add member

Changed on

Adds a member to one of your accounts, with a phone number of their own. The member takes a seat the account already pays for and no one uses, or one more seat on the account's subscription, which you pay: Allo draws on your prepaid credit first, then charges your card on file for the rest. The seat includes the member's number, so the number is not billed on top. Allo sends the member no invitation email. Allo checks that a number is available before charging anything. Requires the PARTNER scope.

post/v2/api/partner/accounts/{id}/members

Request

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

Path parameters

idstring required

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

Request body

emailstring required

Becomes the member's login. It must not belong to an Allo account yet.

namestring required
personal_mobilestring nullable

Optional, E.164. The member's own mobile. It must not belong to an Allo account yet.

role'ADMIN' | 'MANAGER' | 'MEMBER' nullable

Optional, default MEMBER. The member's role in the account's workspace.

Example request

{
  "email": "paul@example.com",
  "name": "Paul Martin",
  "personal_mobile": "+33612345679",
  "role": "MEMBER",
  "number_preference": {
    "country": "FR",
    "prefix": "7",
    "esim": true
  }
}

Response

Member added

Example response

{
  "data": {
    "id": "usr-8C1B2E7F4A9D3C6B0E5F1A2D7C4B9E3F6A0D8C21",
    "account_id": "usr-575966AF3661061265263C58882BC409D2A427B8",
    "email": "paul@example.com",
    "name": "Paul Martin",
    "role": "MEMBER",
    "phone_numbers": [
      "+33745805111"
    ],
    "status": "ACTIVE"
  }
}

Changes