Update a contact group

Vorschau

patchhttps://api.expiryedge.com/v2/contact-groups/{id}

editor or admin60/min

Anfrage

curl -X PATCH 'https://api.expiryedge.com/v2/contact-groups/gro_123' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "State Boards"
}'

Antwort

{
  "id": "gro_123",
  "organization_id": "org_123",
  "name": "Example name",
  "color": "#1E88E5",
  "sort_order": 1,
  "created_by": "string",
  "created_at": "2026-09-27T14:05:00.000Z",
  "updated_at": "2026-09-27T14:05:00.000Z"
}

A rename also renames the group on every member contact.

Pfadparameter

idstringerforderlich

Body-Parameter

application/json

namestring
max length: 100
colorstring
pattern: ^#[0-9a-fA-F]{6}$
sort_orderinteger

Rückgabe

200

The group after the change.

idstring
organization_idstring
namestring
colorstring
sort_orderinteger
created_bystring | null
created_atstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time
updated_atstring
UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
format: date-time

Fehler

`400`	Invalid parameters or body (`VALIDATION_FAILED`; `details` names the fields).
`401`	Missing, invalid or expired token (`UNAUTHORIZED`).
`403`	Your role can't do this, or your account has no organization (`FORBIDDEN`).
`404`	No such record in your organization (records in other organizations are also 404).
`405`	Wrong HTTP method for this path; the `Allow` header lists the valid ones.
`409`	State or uniqueness conflict: `EMAIL_EXISTS` (contacts), `GROUP_EXISTS` (contact groups), `CONFLICT` (folder name taken), `FOLDER_NOT_EMPTY`, `CLIENT_HAS_PROJECTS`, `TOO_MANY_ATTACHMENTS`, `INVALID_STATE` (collection request cancel/resend), or `IDEMPOTENCY_IN_PROGRESS` (same Idempotency-Key still running; see Retry-After).
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.