latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Contacts

Update contact`s custom field

REQUIRED SCOPES <code>['contacts:write']</code><br> This request allows for updating properties of each custom field separately by contact id and a particular field’s key. As a result, the endpoint returns a contact’s fields already updated. <br><br>So as we call all the custom fields again, we will see this custom field updated.<br><br>Note. For Custom field of the date type, the format is YYYY-MM-DD.

put/contacts/{contact}/custom-fields

Path parameters

contactinteger required

ID of contact

Query parameters

custom_field_keystring required
Example:custom.email

Custom Field Key

valuestring required
Example:email@example.com

Value

Response

OK

idinteger

Returns the contact in array format.

owner_idinteger
colorstring
first_namestring
last_namestring
full_namestring
emailstring
photo_urlstring
numberstring
countrystring
country_calling_codestring
national_numberstring
typeted_numberstring
is_blockedboolean
opt_outboolean
opt_out_atstring
opt_in_request_atstring
opt_in_atstring
created_atstring
updated_atstring
integration_vendor_idinteger
prevent_autolinkboolean