Contacts

Update contact

Update an existing contact

patch/v1/contacts/{contact_id}

Path parameters

contact_idstring required

The ID of the contact to update

Request body

numberstring

The contact's phone number

namestring nullable

The contact's name

emailstring email nullable

The contact's email address

address1string nullable

The contact's address line 1

statestring nullable

The contact's state

zipstring nullable

The contact's zip code

citystring nullable

The contact's city

notesstring nullable

Notes about the contact

customobject nullable

Custom JSON data for the contact

is_unsubscribedboolean nullable

Whether the contact has unsubscribed

Example request

{
  "number": "+18005551234",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "address1": "123 Main St",
  "state": "CA",
  "zip": "90210",
  "city": "Los Angeles",
  "notes": "Prefers to be contacted in the evening"
}

Response

Success

Changes

No recorded changes to this endpoint across all 1 revision of this API.