API ReferenceContacts

Update Contact

Update an existing contact.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

This endpoint expects and object.

Only the fields provided in the request will be updated, while all other existing contact data remains unchanged.

idstringRequired

ID of the contact you want to update. This identifier is a string that always begins with the prefix co_, for example: co_1234567890.

descriptionstring or nullOptional
New notes or details for your contact.
emailstring or nullOptional
New email address for your contact.
namestring or nullOptional
New name for your contact.
tagslist of stringsOptional
New tags for your contact.

Response

Successfully updated the contact.
idstring

Unique ID of the updated contact. This identifier is a string that always begins with the prefix co_, for example: co_1234567890.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error