PATCH/v1/groups/{group_id}beta

Rename a contact group

Needs: Create and edit contacts, tags, contact groups and custom fields (crm:write)
Plan: Any plan with API access
Limits: 60 a minute per key
Dry run: Yes — every check runs with ?dry_run=true, nothing changes
Undo: Send the old name and emoji back.

Renames a group and/or changes its emoji. Its contacts are not affected. Pass at least one of name and emoji.

Try it

Path

group_idrequired

The group id.

Edit as JSON

nameoptionalstring

New name.

emojioptionalstring

New emoji.

Idempotency-Keyoptional — made for you if empty

Protects against doing it twice if you retry: a retry with the same key gets the first answer back instead of running again.

Test mode (dry run): nothing will change

Run liveTurns test mode off for this page only. It switches back when you leave the page.

curl -X PATCH 'https://mcp.wa-api.cloud/v1/groups/6?dry_run=true' \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "VIP (2026)"
}'

The code reads your key from $API_KEY.

Parameters

Parameters
Field	Type	What it is
group_idrequired	string \| integer · path	The group id.pattern `^[1-9]\d{0,18}$`

Body

Body fields
Field	Type	What it is
name	string	New name.1–100 characters
emoji	string	New emoji.1–10 characters

Headers

Headers
Field	Type	What it is
Authorizationrequired	header	`Bearer $API_KEY` — your API key.
Api-Version	header	The API version to use, e.g. `2026-10-01`. Default: the version your key is pinned to.one of: `2026-10-01` · pattern `^\d{4}-\d{2}-\d{2}$`
Idempotency-Key	header	Any unique string (8–128 characters). A retry with the same key returns the first answer instead of running twice. Kept 24 hours.pattern `^[A-Za-z0-9._:-]+$` · 8–128 characters

Response `200`

The updated group.

Response fields
Field	Type	What it is
idrequired	string
namerequired	string or null
emojirequired	string or null
dry_run	boolean	`true` when this was a dry run: every check ran and nothing changed.

Errors

Errors are application/problem+json. Branch on code.

Status	Code	When
400	invalid_input	A field is missing or has the wrong format. `errors[]` points at each field.
401	unauthenticated	The Authorization header is missing, the key is unknown, expired or revoked.
403	entitlement_required	The workspace's plan does not include API access (`api_access`).
403	insufficient_scope	The key does not have the permission this operation needs.
404	not_found	No group with this id in your workspace.
409	conflict	Another group already has this name (`reason: duplicate`). Also returned while a request with the same Idempotency-Key is still running.
429	rate_limited	The key or workspace went over its rate limit. Wait for `Retry-After` seconds.
503	upstream_unavailable	A service behind the API is briefly unavailable. Safe to retry with backoff.
504	timeout	The change did not finish in time. Retry with the same Idempotency-Key: it never runs twice.

Examples

Rename a group

Request body

{
  "name": "VIP (2026)"
}

Response 200

{
  "id": "6",
  "name": "VIP (2026)",
  "emoji": "⭐"
}

Operation path

The same operation is also at POST /v1/ops/crm_update_group, with every field in the JSON body.