Remove Person attributes by network ID and instance

Details

Removes attributes passed in the request body from the Person associated with the network ID passed in the URL. This call performs the same action as disassociating an attribute (system or author) from a Person in the Care UI by hitting the “x” icon, but has the advantage of allowing multiple attributes to be split at the same time into the same new person.

📘

Note

The networkid specified in the URL defines which Person account to work with. You will specify which attributes to remove in the request body.

This example request body removes the specified Instagram author handle and the birthday system attribute.

{
  "birthday": "2018-01-01",
  "handles": {
    "instagram": [
      {
        "networkinstance": "instagram",
        "id": "789"
      }
    ]
  }
}

After a call has been made, a new Person is created in the system with the attributes defined in the request body.

In the response (in the sidebar), you'll notice two separate person entries with unique id`` and displayNumber fields. The first is the new person created from ID associated with the "mycommunity.lithium.com/ network instance passed in the request body. The second person entry is the one associated with the Facebook ID 478385502293019 defined in the URL.

Here is an example payload for POST call to /api/v2/authors/networks/facebook/ids/478385502293019/split, with the following passed in the request body:

{
  "handles": {
    "lithium": [
      {
        "networkinstance": "mycommunity.lithium.com/",
        "id": "2279"
      }
    ]
  }
}