Gruppen
Gruppenziel erstellen
Registriert eine Gruppe, die bereits vom Konto-Connector autorisiert wurde.
POST
/groupsgroups:writeVERHALTEN
Die Änderung wird validiert und im Schlüsselkonto gespeichert, bevor reagiert wird. Fragen Sie die zurückgegebene Ressource als Quelle der Wahrheit ab.
WIRKUNG
Es kann die Ressource ändern und das entsprechende Domänenereignis ausgeben.
WIEDERHOLUNG
Bestätigen Sie bei einem Netzwerkfehler den Ressourcenstatus, bevor Sie es erneut versuchen. Nur 429 und 5xx mit Backoff und Jitter automatisch wiederholen.
Anfrage
namestring · bodyGruppenname.minLength 2 · maxLength 160obligatorischexternal_idstring · bodyVom Connector zurückgegebener Bezeichner; kommt nie als Antwort zurück.minLength 2 · maxLength 240obligatorischconnection_idstring · bodyVerbindung, die die Gruppe verwaltet.optionalsegment_idstring · bodyAnfangssegment.optionalrolestring · bodyRolle: Versand, Überwachung oder beides.optionalcapacityinteger · bodyOperative Kapazität.min 1 · max 1000000optionalautomationboolean · bodyAktiviert die Automatisierung.optionalAuthorization
Bearer ach_live_...Accept
application/jsonUmfang
groups:writeAusführbares Beispiel
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"
}'Reaktion und Fehler
Jede Antwort enthält request_id. Listen fügen Paginierung hinzu; Veränderbare Ressourcen geben nach der Operation den persistenten Zustand zurück.
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 erstellt und beibehalten.400Ungültiger Parameter, Körper oder Übergang.401Fehlender, ungültiger, abgelaufener oder widerrufener Schlüssel.402Der Account-Plan gibt diese Schnittstelle nicht frei.403A chave precisa do escopo groups:write.404Die Funktion ist in diesem Konto nicht vorhanden.409Der aktuelle Status verhindert diesen Vorgang.413Der JSON-Körper ist größer als 128 KB.429Das Zeitfenster von 120 Anfragen pro Minute wurde überschritten.