Skip to content

Update Contact

Tool name: update-contact-values

Updates specified contact-field values without changing subscription or channel state. Accepts displayed or ISO 8601 dates and times. An empty value clears a field.

Input schema

contactIdinteger, >= 1required

Numeric contact ID returned by search-contacts

fieldsArray of objects, [ 1 .. 50 ] itemsrequired

Contact field updates; fieldId must be a global field key or an account-owned numeric custom-field ID, a date, time or datetime value takes the form get-contact answers with, and referenceId defaults to 0

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{ "contactId": 1, "fields": [ { "fieldId": "string", "value": "string", "referenceId": 0 } ], "accountId": null }

Output schema

updatedFieldIdsArray of stringsrequired
contactobjectrequired
Output example
{ "updatedFieldIds": [ "string" ], "contact": { "accountId": 0, "contactId": 0, "email": "string", "subscriptionStatus": "string", "referenceId": 0, "fields": [ { "fieldId": "string", "value": "string", "type": "string", "referenceId": 0 } ], "manualTagIds": [ 0 ], "editUrl": "string" } }