Update Contacts (Batch)

❗️

This is NOT a partial update

This API should not be used to update the contact unless you have the entire contact object. For partial update see (Update Contact Partially). Any node not specified in the payload will be removed from the contact.

This API method cannot be used to remove a contact from a group

🚧

Tips and tricks

• Use this call to add/update existing contacts, use DELETE /groups/{organizationId}/ contacts to delete a contact from a group.
• Including the ID field in the request body is ignored. The contact to update is specified by the {contactId} given on the URI.
• Update the externalId value even if that's what you're using to identify the contact to update.
• Specifying an external ID in the request body that is different that the URI will attempt to update the contact's external ID.
  • If the external ID value is already in the database, an error will be returned.
• Omitting a field entirely will update the missing field to be empty (for all non-array
  based fields).
• For contactAttributes, omitting one of the array elements will clear that one value. Omitting the entire contactAttributes, field will clear all additional information for that contact.
• For topic (subscriptions) omit IDs to remove, or omit the entire field to remove all topics.
• For addresses, omit a single one to remove it, or omit the entire addresses field to
  remove all addresses.
  • For an address to show up on the map, you must include GIS coordinates.

NOTE:

1. This API method cannot be used to remove a contact from a group
2. Omitting a field from the request body will delete the value from the contact. Refer request example Basic request to update Contact. In that example, every single value field on the record, except for the four field specified, would be deleted.

Using Name to Identify ID Feature

Some name fields can be used to identify ID. If both exist, the id is high priority.

recordTypeId and recordTypeName

{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817
}

Below request also work well.
{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeName": "Employee"
}

groups and groupsName

{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817,
    "groups": [
        1,
        2,
        3
    ]
}

Below request also work well.
{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817,
    "groupsName": [
        "group1",
        "group2",
        "group3"
    ]
}

Contact Attributes: orgAttrId and name

{
    "id": 1509768514502692,
    "name": "attr1",
    "dataType": "STRING",
    "definedValues": [
        "option1",
        "option2",
        "option3"
    ],
    "displayFormat": "S"
}

{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817,
    "contactAttributes": [
        {
            "orgAttrId": 1509768514502692,
            "name": "attr1",
            "values": [
              "option1",
              "option2"
            ]
        }
    ]
}

Below request also work well.
{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817,
    "contactAttributes": [
        {
            "name": "attr1",
            "values": [
              "option1",
              "option2"
            ]
        }
    ]
}

Contact Path: pathId and prompt

{
    "pathId": 241901148045319,
    "prompt": "phone"
}

{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817,
    "paths": [
        {
            "pathId": 241901148045319,
            "countryCode": "CN",
            "value": "17525889654"
        }
    ]
}

Below request also work well.
{
    "firstName": "F",
    "lastName": "L",
    "externalId": "001",
    "recordTypeId": 1533823015714817,
    "paths": [
        {
            "prompt": "phone",
            "countryCode": "CN",
            "value": "17525889654"
        }
    ]
}

The following APIs can be used to find the IDs of resources used for updating Contact:

• paths: pathId-List Contact Paths
• contactAttributes: Coming soon
• groups: Coming soon
• accountId: Coming soon

Request body