Gruppi
Crea destinazione di gruppo
Registra un gruppo già autorizzato dal connettore dell'account.
POST
/groupsgroups:writeCOMPORTAMENTO
La modifica viene convalidata e mantenuta nell'account chiave prima di rispondere. Interroga la risorsa restituita come fonte di verità.
EFFETTO
Può modificare la risorsa ed emettere l'evento di dominio corrispondente.
RIPETIZIONE
In caso di errore di rete, verificare lo stato della risorsa prima di riprovare. Ripristina automaticamente solo 429 e 5xx con backoff e jitter.
Richiesta
namestring · bodyNome del gruppo.minLength 2 · maxLength 160obbligatorioexternal_idstring · bodyIdentificatore restituito dal connettore; non torna mai in risposta.minLength 2 · maxLength 240obbligatorioconnection_idstring · bodyConnessione che gestisce il gruppo.facoltativosegment_idstring · bodySegmento iniziale.facoltativorolestring · bodyRuolo: spedizione, monitoraggio o entrambi.facoltativocapacityinteger · bodyCapacità operativa.min 1 · max 1000000facoltativoautomationboolean · bodyAttiva l'automazione.facoltativoAuthorization
Bearer ach_live_...Accept
application/jsonAmbito
groups:writeEsempio eseguibile
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"
}'Risposta ed errori
Ogni risposta include request_id. Gli elenchi aggiungono l'impaginazione; le risorse mutabili restituiscono lo stato persistente dopo l'operazione.
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..."
}201Risorsa creata e persistente.400Parametro, corpo o transizione non validi.401Chiave mancante, non valida, scaduta o revocata.402Il piano dell'account non rilascia questa interfaccia.403A chave precisa do escopo groups:write.404La funzionalità non esiste in questo account.409Lo stato attuale impedisce questa operazione.413Il corpo JSON supera i 128 KB.429La finestra di 120 richieste al minuto è stata superata.