contacts

Create contact group

Create a static contact list, then fill it via the members endpoint.

business_id is required when the workspace manages multiple businesses; groups never mix client lists.

Add members with PUT /api/v1/groups/{id}/members (body: contact_ids, max 500 per call); remove with DELETE on the same path.

Adding a contact from a different business is skipped, not an error. The response reports added / already_members / skipped honestly.

post/api/v1/groups

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/groups
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

A unique key (e.g. a UUID) that makes a POST safe to retry: replaying the same key within 24h returns the original result instead of acting twice.

Request body

namestring required
descriptionstring nullable
business_idstring uuid

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": "91058129-11e4-4112-ac85-faebb7237189",
  "business_id": "22222222-2222-4222-9222-222222222222",
  "name": "Spring launch invitees",
  "description": "Imported from the events CRM",
  "created_at": "2026-05-22T10:30:00.000Z",
  "updated_at": "2026-05-22T10:30:00.000Z",
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

Changes

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