CounterpartyGroupsUpdate a group

Update a group

Gated by the counterparty_group_update policy; may return an approval request

curl -X PATCH "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/counterparty-groups/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "John Doe",
  "description": "example_string",
  "avatarUri": "example_string",
  "color": "example_string",
  "emoji": "example_string"
}'
{
  "id": "cmr3f41z20001psp7phmyapw3",
  "vaultId": "example_string",
  "code": "exchanges",
  "name": "Exchanges",
  "description": "example_string",
  "avatarUri": "example_string",
  "color": "example_string",
  "emoji": "example_string",
  "archivedAt": "2026-07-02T11:25:15.134000Z",
  "createdAt": "2026-07-02T11:25:15.134000Z",
  "updatedAt": "2026-07-02T11:25:15.134000Z"
}
PATCH
/api/v1/vaults/{code}/counterparty-groups/{id}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

path
codestring
Required

Unique Vault code (slug)

path
idstring
Required

Group id (cuid)

Content-Typestring
Required

The media type of the request body

Options: application/json
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

codestring
Required

Unique Vault code (slug)

Example:
demo_vault
idstring
Required

Group id (cuid)

Responses

idstring
Required

cuid

vaultIdstring
Required
codestring
Required
namestring
Required
descriptionstring
Required
avatarUristring
Required
colorstring
Required
emojistring
Required
archivedAtstring
Required
createdAtstring
Required
updatedAtstring
Required