Groups

7 endpoints, each with examples that open in the console prefilled.

GET/api/v1/groupscontacts:readTry in console

List contact groups

Static contact lists with live member counts: the audiences campaigns can target.

Pass a group id as a campaign's audience list to target its members.
Page with ?limit= (max 200, default 200) and ?cursor= (the previous page's next_cursor); groups are ordered by name.
PATCH /api/v1/groups/{id} renames; DELETE refuses with 409 resource_in_use while a scheduled or running campaign still targets the group.

curl -X GET "https://app.blueticked.com/api/v1/groups" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"

Response

{
  "data": [
    {
      "id": "ed469250-95e6-4c29-a111-5189530656a7",
      "business_id": "22222222-2222-4222-9222-222222222222",
      "name": "VIP customers",
      "description": null,
      "contact_count": 128,
      "created_at": "2026-05-22T10:30:00.000Z",
      "updated_at": "2026-05-22T10:30:00.000Z"
    }
  ],
  "next_cursor": null,
  "has_more": false,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

POST/api/v1/groupscontacts:writeTry in console

Create contact group

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

Body parameters

namerequired	string
description	string
business_id	string

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.

curl -X POST "https://app.blueticked.com/api/v1/groups" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: change-me-per-request-0001" \
  -d '{
  "name": "Spring launch invitees",
  "description": "Imported from the events CRM",
  "business_id": "22222222-2222-4222-9222-222222222222"
}'

Response

{
  "id": "91058129-11e4-4112-ac85-faebb7237189",
  "business_id": "22222222-2222-4222-9222-222222222222",
  "name": "Spring launch invitees",
  "description": "Imported from the events CRM",
  "contact_count": 0,
  "created_at": "2026-05-22T10:30:00.000Z",
  "updated_at": "2026-05-22T10:30:00.000Z",
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

GET/api/v1/groups/{id}contacts:readTry in console

Get a contact group

Fetch one contact group with its live member count.

Returns 404 not_found when the group does not exist in your workspace.

curl -X GET "https://app.blueticked.com/api/v1/groups/{id}" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"

Response

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

PATCH/api/v1/groups/{id}contacts:writeTry in console

Rename a contact group

Rename a contact group or edit its description.

Body parameters

name	string
description	string

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

curl -X PATCH "https://app.blueticked.com/api/v1/groups/{id}" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP customers (2026)",
  "description": "Top accounts by spend"
}'

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"
}

DELETE/api/v1/groups/{id}contacts:writeTry in console

Delete a contact group

Soft-delete a contact group and clear its membership rows.

Irreversible from the API: the group is soft-deleted and drops out of every list; recreate it if you need it back.
Refused with 409 resource_in_use while a scheduled/running campaign or an active recurring schedule still targets the group. details lists the blocking campaigns and schedules by name.
Deleting a group never deletes its contacts, only the list and its membership links.

curl -X DELETE "https://app.blueticked.com/api/v1/groups/{id}" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY"

Response

{
  "id": "ed469250-95e6-4c29-a111-5189530656a7",
  "deleted": true,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

PUT/api/v1/groups/{id}/memberscontacts:writeTry in console

Add contacts to a group

Add up to 500 contacts to a group in one call.

Body parameters

contact_idsrequired

string[]

contact_ids accepts 1 to 500 contact UUIDs per call (the id values returned by the contacts endpoints).
Only contacts inside the group's business are added; a contact from a different business is counted under skipped, not an error, and contacts already in the group count under already_members.

curl -X PUT "https://app.blueticked.com/api/v1/groups/{id}/members" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_ids": [
    "ff506e53-e2f0-4d92-884a-dab77d628bad",
    "0acebb85-5297-4455-8465-4f09ac9cb556"
  ]
}'

Response

{
  "group_id": "ed469250-95e6-4c29-a111-5189530656a7",
  "added": 2,
  "already_members": 0,
  "skipped": 0,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}

DELETE/api/v1/groups/{id}/memberscontacts:writeTry in console

Remove contacts from a group

Remove contacts from a group by id.

Body parameters

contact_ids

string[]

Removing a contact never deletes the contact, only its membership in this group.

curl -X DELETE "https://app.blueticked.com/api/v1/groups/{id}/members" \
  -H "Authorization: Bearer $BLUETICKED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_ids": [
    "ff506e53-e2f0-4d92-884a-dab77d628bad"
  ]
}'

Response

{
  "group_id": "ed469250-95e6-4c29-a111-5189530656a7",
  "removed": 1,
  "request_id": "req_b2e3d610e10f1b07468721ee98f0e1d2"
}