v50

latestOpenAPI 3.0.0Proprietaryraw.githubusercontent.com2026-06-1841147599.2 KB

Contacts

Update a contact

Updates a contact's default channel and/or opt-out status. Inherited contacts cannot be updated.

patch/v3/contacts/{id}

Path parameters

idstring uuid required

Contact ID from route parameter

Headers

Idempotency-Keystring

Unique key to ensure idempotent request processing. Must be 1-255 alphanumeric characters, hyphens, or underscores. Responses are cached for 24 hours per key per customer.

x-profile-idstring uuid

Profile UUID to scope the request to a child profile. Only organization API keys can use this header. The profile must belong to the calling organization.

Request body

sandboxboolean

Sandbox flag - when true, the operation is simulated without side effects Useful for testing integrations without actual execution

default_channelstring nullable

Default messaging channel: "sms" or "whatsapp"

opt_outboolean nullable

Whether the contact has opted out of messaging. Single source of truth — opt-out is per-contact, not per-channel.

Example request

{
  "default_channel": "whatsapp",
  "opt_out": false,
  "sandbox": false
}

Response

Contact updated successfully

successboolean

Indicates whether the request was successful