Groups

Update group

Updates name, segment, capacity and automation.

PATCH/groups/{id}groups:write

BEHAVIOR

The change is validated and persisted in the key account before responding. Query the returned resource as the source of truth.

EFFECT

It can change the resource and emit the corresponding domain event.

REPETITION

On network failure, confirm the resource status before retrying. Automatically redo only 429 and 5xx with backoff and jitter.

Request

idstring · pathResource identifier.minLength 2 · maxLength 100mandatory

namestring · bodyGroup name.optional

rolestring · bodyGroup role.optional

segment_idstring · bodySegment.optional

capacityinteger · bodyCapacity.optional

automationboolean · bodyActivates automation.optional

activeboolean · bodyActivate the group.optional

AuthorizationBearer ach_live_...

Acceptapplication/json

Scopegroups:write

Executable example

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

Response and errors

Every response includes request_id. Lists add pagination; mutable resources return the persisted state after the operation.

200 application/json

{
  "data": {
    "id": "grp_01J...",
    "name": "Home deals",
    "members": 842,
    "active": 1,
    "capacity": 1024,
    "segment_id": "seg_01J..."
  },
  "request_id": "req_01J..."
}

200Operation completed.

400Invalid parameter, body or transition.

401Missing, invalid, expired or revoked key.

402The account plan does not release this interface.

403A chave precisa do escopo groups:write.

404Feature does not exist in this account.

409The current state prevents this operation.

413The JSON body exceeds 128 KB.

429The 120 requests per minute window has been exceeded.

Update group

Request

Executable example

Response and errors

Related operations