contacts

Update a contact

Partially update a contact's profile, tags, or suppressed flag.

Send only the fields you want to change, and at least one field: an empty body answers 400 validation_failed. Changing or clearing phone/email clears consent for the old identifier.

Set a matching *_consent field to true to record fresh permission for the effective identifier. Email consent still follows the business's double opt-in policy.

patch/api/v1/contacts/{id}

Request

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

Path parameters

idstring required

The resource's unique identifier.

Request body

business_idstring uuid nullable
phonestring nullable

Phone in international form (+27821234567) or South African national form (082 123 4567); spaces and dashes are ignored. A number without a leading + or 00 is read as South African, so write a foreign number with its +. Stored and returned as E.164.

emailstring nullable
first_namestring nullable
last_namestring nullable
tagsstring[]
custom_fieldsobject
suppressedboolean
whatsapp_consenttrue
sms_consenttrue
email_consenttrue

Response

Success

custom_fieldsobject required
idstring uuid required
business_idstring uuid nullable required
first_namestring nullable required
last_namestring nullable required
phonestring nullable required
emailstring nullable required
tagsstring[] required
suppressedboolean required
created_atstring date-time required
updated_atstring date-time required
request_idstring required

Example response

{
  "id": "ff506e53-e2f0-4d92-884a-dab77d628bad",
  "business_id": "22222222-2222-4222-9222-222222222222",
  "first_name": "Samuel",
  "last_name": "Mokoena",
  "phone": "+27800000001",
  "channels": {
    "has_whatsapp": true,
    "whatsapp_opted_in_at": "2026-05-22T10:30:00.000Z",
    "has_sms": true,
    "sms_opted_in_at": "2026-05-22T10:30:00.000Z"
  },
  "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.