Ga naar de inhoud
AchaduDevelopers
Operationele APIGa naar website ↗
Dashboard →
Developers/API/group_update
Groepen

Groep bijwerken

Updates naam, segment, capaciteit en automatisering.

PATCH/groups/{id}groups: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

idstring · pathResource-ID.minLength 2 · maxLength 100verplicht
namestring · bodyGroepsnaam.optioneel
rolestring · bodyGroepsrol.optioneel
segment_idstring · bodySegmenteren.optioneel
capacityinteger · bodyCapaciteit.optioneel
automationboolean · bodyActiveert automatisering.optioneel
activeboolean · bodyActiveer de groep.optioneel
AuthorizationBearer ach_live_...
Acceptapplication/json
Reikwijdtegroups:write

Uitvoerbaar voorbeeld

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

Reactie en fouten

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

200 application/json
{
  "data": {
    "id": "grp_01J...",
    "name": "Home deals",
    "members": 842,
    "active": 1,
    "capacity": 1024,
    "segment_id": "seg_01J..."
  },
  "request_id": "req_01J..."
}
200Operatie voltooid.
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.