v2

latestOpenAPI 3.1.02026-08-07750280.6 KB

Contacts

Update contact by phone number

Partially update a specific contact by phone number. Supports custom field auto-creation and null semantics.

patch/contacts/by-phone/{phone_number}

Path parameters

phone_numberstring required

Request body

first_namestring

Contact's first name (optional)

last_namestring

Contact's last name (optional)

emailstring email

Contact's email address (optional)

phone_numberstring

Contact's new phone number in E.164 format (optional)

addressstring

Contact's address (optional)

custom_fieldsobject nullable

Custom fields as key-value pairs. Unknown fields are auto-created with type inferred from the value. Set to null to remove ALL custom field values. Set a field's value to null to remove that specific field value.

Example request

{
  "address": "456 New St, City, State",
  "custom_fields": {
    "department": "Marketing",
    "hair_color": "blonde"
  },
  "email": "john.smith@example.com",
  "first_name": "John",
  "last_name": "Smith"
}

Response

Contact updated successfully

okboolean