Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
List

Removes a single entity from the specified list.

post/list/{listId}/entity/remove

Path parameters

listIdstring required
Example:report:P6LnLw

Unique identifier for a list (format: report:XXXXX) or a named watch list identifier, obtained from POST /list/search or POST /list/create.

Request body

Example request

{
  "entity": {
    "id": "B_E7B",
    "provided_id": "B_E7B",
    "type": "Company",
    "name": "Microsoft"
  }
}

Response

Success — returns unchanged if the entity was not on the list.

result'removed' | 'unchanged' required

removed if the entity was removed, or unchanged if the entity was not on the list.