Sign in
Basic

Add and/or Remove Records from a List

Add and/or remove records that have already been created in the system to and/or from a list.

This endpoint only works for lists that have a processingType of MANUAL or SNAPSHOT.

put/crm/v3/lists/{listId}/memberships/add-and-remove

Path parameters

listIdstring required

The ILS ID of the MANUAL or SNAPSHOT list.

Request body

recordIdsToAddstring[] required
recordIdsToRemovestring[] required

Example request

{
  "recordIdsToAdd": [
    "123",
    "456",
    "789"
  ],
  "recordIdsToRemove": [
    "654"
  ]
}

Response

successful operation

recordIdsMissingstring[] required

The IDs of the records that were missing (e.g. did not exist in the portal) and so were not added or removed.

recordIdsRemovedstring[] required

The IDs of the records that were removed from the list.

recordsIdsAddedstring[] required