Passer au contenu
AchaduDevelopers
API opérationnelleAller sur le site Web
Tableau de bord
Developers/API/group_create
Groupes

Créer une destination de groupe

Enregistre un groupe déjà autorisé par le connecteur de compte.

POST/groupsgroups:write
COMPORTEMENT

Le changement est validé et conservé dans le compte clé avant de répondre. Interrogez la ressource renvoyée comme source de vérité.

EFFET

Il peut modifier la ressource et émettre l'événement de domaine correspondant.

RÉPÉTITION

En cas de panne du réseau, confirmez l'état de la ressource avant de réessayer. Refaites automatiquement uniquement 429 et 5xx avec recul et gigue.

Demande

namestring · bodyNom du groupe.minLength 2 · maxLength 160obligatoire
external_idstring · bodyIdentifiant renvoyé par le connecteur ; ne revient jamais en réponse.minLength 2 · maxLength 240obligatoire
connection_idstring · bodyConnexion qui gère le groupe.facultatif
segment_idstring · bodySegment initial.facultatif
rolestring · bodyRôle : expédition, surveillance ou les deux.facultatif
capacityinteger · bodyCapacité opérationnelle.min 1 · max 1000000facultatif
automationboolean · bodyActive l'automatisation.facultatif
AuthorizationBearer ach_live_...
Acceptapplication/json
Portéegroups:write

Exemple d'exécutable

curl
curl -X POST 'https://achadu.com/api/v1/groups' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "name": "My integration",
  "external_id": "string",
  "connection_id": "string",
  "segment_id": "string",
  "role": "string"
}'

Réponse et erreurs

Chaque réponse inclut request_id. Les listes ajoutent une pagination ; les ressources mutables renvoient l'état persistant après l'opération.

201 application/json
{
  "data": {
    "id": "grp_01J...",
    "name": "Home deals",
    "members": 842,
    "active": 1,
    "capacity": 1024,
    "segment_id": "seg_01J..."
  },
  "created": true,
  "request_id": "req_01J..."
}
201Ressource créée et conservée.
400Paramètre, corps ou transition non valide.
401Clé manquante, invalide, expirée ou révoquée.
402Le plan de compte ne libère pas cette interface.
403A chave precisa do escopo groups:write.
404La fonctionnalité n'existe pas dans ce compte.
409L'état actuel empêche cette opération.
413Le corps JSON dépasse 128 Ko.
429La fenêtre de 120 requêtes par minute a été dépassée.