Update a contact

Update an existing contact. Fields you leave out keep their current values. Custom field values in contact.fieldValues are saved in the same request; fields you leave out are not changed. The user needs the edit contacts permission. PATCH on this path behaves exactly like PUT: both methods run the same action, with the same body and responses. If your account uses social channels, custom fields whose service is engage are kept up to date automatically by those channels: values sent for them are ignored, and the other fields still save.

🚧

Organization-Related Nodes Have Been Deprecated

Contact-Organization relationships are now managed through Account-Contact end points

{
  "contact": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "fieldValues": [
      {
        "field": "1",
        "value": "The Value for First Field"
      },
      {
        "field": "6",
        "value": "2008-01-20"
      }
    ],
    "tags": [
      "customer",
      "newsletter"
    ]
  }
}
{
    "fieldValues": [
        {
            "contact": "113",
            "field": "1",
            "value": "The Value for First Field",
            "cdate": "2020-08-01T10:54:59-05:00",
            "udate": "2020-08-01T14:13:34-05:00",
            "links": {
                "owner": "https://:account.api-us1.com/api/3/fieldValues/11797/owner",
                "field": "https://:account.api-us1.com/api/3/fieldValues/11797/field"
            },
            "id": "11797",
            "owner": "113"
        },
        {
            "contact": "113",
            "field": "6",
            "value": "2008-01-20",
            "cdate": "2020-08-01T10:54:59-05:00",
            "udate": "2020-08-01T14:13:34-05:00",
            "links": {
                "owner": "https://:account.api-us1.com/api/3/fieldValues/11798/owner",
                "field": "https://:account.api-us1.com/api/3/fieldValues/11798/field"
            },
            "id": "11798",
            "owner": "113"
        }
    ],
    "contact": {
        "cdate": "2018-09-28T13:50:41-05:00",
        "email": "[email protected]",
        "phone": "",
        "firstName": "John",
        "lastName": "Doe",
        "orgid": "0",
        "segmentio_id": "",
        "bounced_hard": "0",
        "bounced_soft": "0",
        "bounced_date": null,
        "ip": "0",
        "ua": null,
        "hash": "8309146b50af1ed5f9cb40c7465a0315",
        "socialdata_lastcheck": null,
        "email_local": "",
        "email_domain": "",
        "sentcnt": "0",
        "rating_tstamp": null,
        "gravatar": "0",
        "deleted": "0",
        "anonymized": "0",
        "adate": null,
        "udate": "2018-09-28T13:55:59-05:00",
        "edate": null,
        "deleted_at": null,
        "created_utc_timestamp": "2018-09-28 13:50:41",
        "updated_utc_timestamp": "2018-09-28 13:50:41",
        "links": {
            "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/113/bounceLogs",
            "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/113/contactAutomations",
            "contactData": "https://:account.api-us1.com/api/:version/contacts/113/contactData",
            "contactGoals": "https://:account.api-us1.com/api/:version/contacts/113/contactGoals",
            "contactLists": "https://:account.api-us1.com/api/:version/contacts/113/contactLists",
            "contactLogs": "https://:account.api-us1.com/api/:version/contacts/113/contactLogs",
            "contactTags": "https://:account.api-us1.com/api/:version/contacts/113/contactTags",
            "contactDeals": "https://:account.api-us1.com/api/:version/contacts/113/contactDeals",
            "deals": "https://:account.api-us1.com/api/:version/contacts/113/deals",
            "fieldValues": "https://:account.api-us1.com/api/:version/contacts/113/fieldValues",
            "geoIps": "https://:account.api-us1.com/api/:version/contacts/113/geoIps",
            "notes": "https://:account.api-us1.com/api/:version/contacts/113/notes",
            "organization": "https://:account.api-us1.com/api/:version/contacts/113/organization",
            "plusAppend": "https://:account.api-us1.com/api/:version/contacts/113/plusAppend",
            "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/113/trackingLogs",
            "scoreValues": "https://:account.api-us1.com/api/:version/contacts/113/scoreValues"
        },
        "id": "113",
        "organization": null
    }
}
Path Params
int32
required

ID of the contact to update

Body Params
contact
object
required

The fields to change.

boolean

Accepted for compatibility with the custom field value endpoints; it has no effect when saving a contact.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json