Developer Docs Logo
API RequestsAPI SchemaContacts

Upsert Contact Custom Attributes

PATCH/v1/contacts/{contact_id}/custom-attributes

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.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

contact_id*string

The unique identifier (UUID) of the contact.

Formatuuid

Request Body

application/json

A map of custom attribute keys to their values. Values are stored as strings and validated according to each custom attribute's field type.

TypeScript Definitions

Use the request body type in TypeScript.

A map of custom attribute keys to their values. Keys must match existing custom attribute definitions (case-sensitive). Values must match the custom attribute's field type (string for TEXT/LINK/MULTILINE/SELECT/DEPENDENT/DATE, number for NUMBER, float for DECIMAL, boolean for CHECKBOX).

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/contacts/550e8400-e29b-41d4-a716-446655440000/custom-attributes" \  -H "Content-Type: application/json" \  -d '{    "company": "Acme Corporation",    "department": "Sales",    "employee_id": "EMP-12345",    "join_date": "2024-01-15"  }'
Empty