Sign in

v1

latestSwagger 2.02026-08-06291030.8 KB
Contact

Update contact information

Update a contact's status, label, and/or assignee

put/contact/{token}

Path parameters

tokenstring required

Ellipsend Token

Request body

status_idinteger

ID of the status to assign. Use GET /status to retrieve available status IDs.

label_idinteger

ID of the label to assign. Use GET /label to retrieve available label IDs.

assignee_idinteger

ID of the assignee to assign. Must be a valid user ID in your organization. Use GET /assignee to retrieve available assignee IDs.

first_namestring

Contact's first name

last_namestring

Contact's last name

emailstring email

Contact's email address

phonestring

Contact's phone number

addressstring

Contact's physical address

citystring

Contact's city

statestring

Contact's state/province

postal_codestring

Contact's postal/zip code

countrystring

Contact's country

companystring

Contact's company name

titlestring

Contact's job title

custom_fieldsobject

Any additional custom fields defined for the contact

Example request

{
  "status_id": 1,
  "label_id": 2,
  "assignee_id": 3,
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1-555-123-4567",
  "company": "Acme Corp",
  "title": "Sales Manager",
  "custom_fields": {
    "lead_source": "Website",
    "last_interaction": "2024-01-15"
  }
}

Response

Contact updated successfully

messagestring

Example response

{
  "message": "Contact updated successfully"
}