Ga naar de inhoud
AchaduDevelopers
Operationele APIGa naar website
Dashboard
Developers/API/group_create
Groepen

Groepsbestemming aanmaken

Registreert een groep die al is geautoriseerd door de accountconnector.

POST/groupsgroups:write
GEDRAG

De wijziging wordt gevalideerd en gehandhaafd in het hoofdaccount voordat er wordt gereageerd. Query's uitvoeren op de geretourneerde bron als de bron van de waarheid.

EFFECT

Het kan de bron wijzigen en de bijbehorende domeingebeurtenis uitzenden.

HERHALING

Bij een netwerkfout bevestigt u de bronstatus voordat u het opnieuw probeert. Alleen 429 en 5xx automatisch opnieuw uitvoeren met backoff en jitter.

Verzoek

namestring · bodyGroepsnaam.minLength 2 · maxLength 160verplicht
external_idstring · bodyIdentificatie geretourneerd door de connector; komt nooit meer terug als reactie.minLength 2 · maxLength 240verplicht
connection_idstring · bodyVerbinding die de groep beheert.optioneel
segment_idstring · bodyInitieel segment.optioneel
rolestring · bodyRol: expeditie, monitor of beide.optioneel
capacityinteger · bodyOperationele capaciteit.min 1 · max 1000000optioneel
automationboolean · bodyActiveert automatisering.optioneel
AuthorizationBearer ach_live_...
Acceptapplication/json
Reikwijdtegroups:write

Uitvoerbaar voorbeeld

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"
}'

Reactie en fouten

Elk antwoord bevat request_id. Lijsten voegen paginering toe; veranderlijke bronnen retourneren de persistente status na de bewerking.

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..."
}
201Resource gemaakt en bewaard.
400Ongeldige parameter, hoofdtekst of overgang.
401Ontbrekende, ongeldige, verlopen of ingetrokken sleutel.
402Het accountplan geeft deze interface niet vrij.
403A chave precisa do escopo groups:write.
404Functie bestaat niet in dit account.
409De huidige status verhindert deze bewerking.
413De JSON-hoofdtekst is groter dan 128 KB.
429Het venster van 120 verzoeken per minuut is overschreden.