Developer Docs Logo
API RequestsAPI SchemaContacts

Update Contact Information

PATCH/v1/contacts/{contact_id}

Partially updates a contact's information. Only provided fields will be updated. Requires contact:write scope.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

contact_id*string

The unique identifier (UUID) of the contact.

Formatuuid

Request Body

application/json

The contact information to update. All fields are optional.

TypeScript Definitions

Use the request body type in TypeScript.

Request body for updating a contact. All fields are optional.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/contacts/550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{    "name": "John Updated",    "phone_number": "6289876543210",    "email": "john.updated@example.com"  }'
Empty

Get Contact Details GET

Retrieves detailed information about a specific contact. Requires `contact:read` scope.

Upsert Contact Custom Attributes PATCH

Creates or updates custom attributes for a contact. Keys must match existing custom attribute definitions in your workspace and are case-sensitive. Requires `contact:write` scope.