Passer au contenu principal
POST

Cibler la file d’un coequipier

Par defaut, les numeros sont ajoutes a la file assignee au proprietaire de la cle API. Pour ajouter a la file d’un coequipier, envoyez user_id ou email dans le corps JSON. Le coequipier doit appartenir a la meme equipe que le proprietaire de la cle API.
  • user_id — l’emporte quand les deux sont fournis. Resolvez les ids des coequipiers via GET /v2/api/users.
  • email — utilise uniquement quand user_id est absent.
Si le coequipier n’a pas de file en cours, une nouvelle file est creee avec le proprietaire de la cle API comme creator_id et le coequipier comme assignee_id. Si l’utilisateur resolu n’est pas dans votre equipe, la reponse est 404 ASSIGNEE_NOT_FOUND.

Champs personnalisés

Chaque numéro peut porter custom_attributes : des valeurs pour les champs personnalisés des personnes de votre équipe, indexées par la key du champ. Listez les clés avec GET /v2/api/crm/attributes. Les valeurs sont écrites sur le contact du numéro, et le contact est créé si le numéro n’en a pas.
Les valeurs sont des chaînes, au format du champ :

Ordre des dates

03/04/2026 est le 3 avril en Europe et le 4 mars aux États-Unis. Envoyez date_order à côté de numbers pour préciser lequel : DAY_FIRST ou MONTH_FIRST. Il s’applique à tous les champs date de la requête.
Sans date_order, chaque champ date est lu dans l’ordre que ses propres valeurs imposent : 13/04/2026 ne peut être que jour en premier, 04/13/2026 que mois en premier. Quand les valeurs ne tranchent pas, le pays de votre numéro décide : mois en premier pour les États-Unis, jour en premier partout ailleurs. Les valeurs vides sont ignorées. Quand le contact existe déjà, seuls ses champs vides sont remplis : une valeur déjà renseignée est conservée. Cet endpoint ne crée jamais de champ personnalisé. Créez-les d’abord avec POST /v2/api/crm/attributes. Une clé qui ne correspond à aucun champ personnalisé de votre équipe, ou qui désigne un champ supprimé, est ignorée. Le numéro est tout de même ajouté avec ses attributs connus, et les clés inconnues sont listées dans ignored_custom_attributes : un tableau toujours présent d’entrées { "number", "keys" }, avec number au format E.164. Le tableau est vide quand aucune clé n’a été ignorée.
Une clé connue avec une valeur inutilisable, c’est autre chose : le numéro n’est pas ajouté et revient dans skipped :

Autorisations

Authorization
string
header
requis

Corps

application/json
numbers
object[]
requis

Numbers to append to the queue. Each entry requires a phone number; contact metadata is optional.

Minimum array length: 1
user_id
string | null

Optional. ID of a teammate whose queue should receive the numbers. The teammate must belong to the same team as the API key owner. Wins over email when both are provided. Resolve teammate ids via GET /v2/api/users.

Exemple:

"usr-15BB68317A7F06F0C07A3BBD8F244102A6872220"

email
string<email> | null

Optional. Email of a teammate whose queue should receive the numbers. Ignored when user_id is also supplied.

date_order
enum<string> | null

Optional. How to read numeric DATE values in custom_attributes such as 03/04/2026: DAY_FIRST (3 April) or MONTH_FIRST (4 March). Applies to every date field in the request. When absent, each date field is read in the order its values settle (a 13/04/2026 can only be day first); when none settle it, your phone number's country decides: month first for the US, day first everywhere else.

Options disponibles:
DAY_FIRST,
MONTH_FIRST
Exemple:

"DAY_FIRST"

Réponse

Numbers appended

data
object