contacts

Rename a contact group

Rename a contact group or edit its description.

Send only the field you want to change; pass description: null to clear it.

patch/api/v1/groups/{id}

Request

Base URL: https://app.blueticked.com
URL: https://app.blueticked.com/api/v1/groups/{id}
Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Request body

namestring

descriptionstring nullable

Response

Success

idstring uuid required

business_idstring uuid nullable required

namestring required

descriptionstring nullable required

contact_countnumber required

created_atstring date-time required

updated_atstring date-time required

request_idstring required

Example response

{
  "id": "ed469250-95e6-4c29-a111-5189530656a7",
  "business_id": "22222222-2222-4222-9222-222222222222",
  "name": "VIP customers (2026)",
  "description": "Top accounts by spend",
  "contact_count": 128,
  "created_at": "2026-05-22T10:30:00.000Z",
  "updated_at": "2026-05-22T11:00:00.000Z",
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.