Update a person by id.
Tag updates will overwrite all existing tags
Please note that when using the tags property, all existing tags for a person will be overwritten to use the new list of tags provided.
To merge new tags with the contact's existing tag list, set the
mergeTags
query parameter in the request URL to true.
Altering email addresses and phone numbers of relationships
Email addresses and phone numbers associated to relationships can be edited and deleted through
/v1/people
, however you cannot alter therelationshipId
of a given email address or phone number through/v1/people
. This must be done through/v1/peopleRelationships
.
Changing the
contacted
fieldChanging the
contacted
field totrue
will pause action plans.
Custom Fields
If the account has custom fields defined you can also set these when updating a person. You can use the customFields endpoint to see which custom fields are available in the current account.
To delete a custom field value on a person, set its value to null. (e.g.,
customBirthday: null
)