API ReferenceContacts

Update contact

View as Markdown

Updates a single workspace contact. Requires the contacts:write scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

contact_idstringRequired

Request

This endpoint expects an object.
first_namestring or nullOptional1-255 characters
last_namestring or nullOptional1-255 characters
descriptionstring or nullOptional1-2000 characters
company_idstring or nullOptionalformat: "^cmp_[A-Za-z0-9]+$"
emailslist of objectsOptional
phone_numberslist of objectsOptional
time_zonestring or nullOptional1-255 characters

Response headers

X-Api-Versionstring

Response

Updated contact response.
objectenum
Resource discriminator for contact payloads.
Allowed values:
idstringformat: "^cnt_[A-Za-z0-9]+$"
Stable AskElephant contact identifier.
created_atdatetime
Timestamp when the contact was first created in AskElephant.
updated_atdatetime
Timestamp when the contact was most recently updated in AskElephant.
first_namestring or null
Contact given name.
last_namestring or null
Contact family name.
descriptionstring

Free-form contact summary or notes visible through the public API.

companyobject
Lightweight reference to the contact's associated company when one exists.
emailslist of objects
Email addresses associated with the contact.
phone_numberslist of objects
Phone numbers associated with the contact.
crm_associationobject
CRM record linked to this contact. Present when the contact has been matched to a CRM record via integration or API.
time_zonestring
IANA time zone identifier for the contact.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error