Skip to main content
POST
Add member
Scope requis : PARTNER
Ajoute un collaborateur à l’un de vos comptes, avec son propre numéro de téléphone. La réponse renvoie le membre, dont l’id qui sert à commander son eSIM.

Requête

  • email est requis et devient l’identifiant de connexion du membre.
  • name est requis.
  • personal_mobile est optionnel, au format E.164, par exemple +33612345679. Un numéro illisible échoue avec INVALID_PHONE_NUMBER.
  • role est optionnel : ADMIN, MANAGER ou MEMBER, MEMBER par défaut. Toute autre valeur échoue avec INVALID_MEMBER_ROLE.
  • number_preference est requis : le numéro du membre, avec les mêmes champs que sur Créer un compte. number_preference.country est requis. Passez number_preference.esim à true pour donner au membre un numéro mobile français qui peut porter une eSIM.
  • Si l’email ou le mobile personnel appartient déjà à un compte Allo, la requête échoue avec 409 PARTNER_ACCOUNT_ALREADY_EXISTS, et param indique le champ concerné.
{id} est l’identifiant du compte renvoyé par Créer un compte. Un compte que votre API key n’a pas créé, ou déjà désactivé, renvoie 404 PARTNER_ACCOUNT_NOT_FOUND.

Ce que fait Allo

  • Allo crée le membre dans le workspace du compte et lui attribue son numéro.
  • Allo n’envoie aucun email d’invitation au membre. C’est vous qui l’accompagnez. Le membre se connecte à Allo avec l’email (ou le mobile personnel) que vous avez envoyé, et activated passe à true dès sa première connexion sur un appareil.
  • Le membre occupe un siège sur l’abonnement du compte. Ce siège inclut son numéro : le numéro n’est pas facturé en plus.

Facturation

  • Si le compte paie déjà un siège que personne n’occupe, le membre le prend et rien n’est débité.
  • Sinon, Allo ajoute un siège à l’abonnement du compte, que vous payez, et débite tout de suite le reste de la période de facturation en cours, avec la remise de l’abonnement appliquée. Allo prélève d’abord votre crédit prépayé, puis débite le reste sur votre carte enregistrée. Allo ne facture jamais votre client.
  • Allo vérifie l’email, le mobile personnel et le numéro avant tout débit. Si aucun numéro ne correspond, la requête échoue avec 409 NO_NUMBER_AVAILABLE et rien n’est débité.
  • Si votre crédit prépayé ne couvre pas le siège et qu’aucune carte n’est enregistrée, la requête échoue avec 402 PARTNER_CREDIT_INSUFFICIENT et rien n’est créé. Une carte refusée échoue avec 402 PARTNER_BILLING_FAILED.
  • Si le numéro du membre ne peut pas être configuré après le débit, Allo supprime le membre et retire le siège de l’abonnement.
L’endpoint ne prend pas d’Idempotency-Key. Si une requête expire, consultez Lister les membres avant de réessayer : une fois le membre créé, une nouvelle tentative avec le même email échoue avec PARTNER_ACCOUNT_ALREADY_EXISTS.

Comment donner une eSIM au membre

1

Ajoutez le membre avec un numéro eSIM

Envoyez number_preference: {"country": "FR", "esim": true}. Le membre reçoit un numéro mobile français qui peut porter une eSIM, listé dans phone_numbers.
2

Commandez l'eSIM pour le membre

Appelez Commander une eSIM sur le même compte (POST /v2/api/partner/accounts/{account_id}/esims). Envoyez le numéro du membre comme phone_number et l’id du membre comme holder_id. L’eSIM est alors rattachée au membre, et non au compte.
3

Remettez l'eSIM

Attendez partner.esim.ready, puis envoyez au membre le code de Obtenir le code d’activation d’une eSIM.

Erreurs

Autorisations

Authorization
string
header
requis

Paramètres de chemin

id
string
requis

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

Corps

application/json
email
string
requis

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

name
string
requis
Exemple:

"Paul Martin"

number_preference
object
requis

The member's number.

personal_mobile
string | null

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

Exemple:

"+33612345679"

role
enum<string> | null

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

Options disponibles:
ADMIN,
MANAGER,
MEMBER
Exemple:

"MEMBER"

Réponse

Member added

data
object