Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
List

Adds a single entity to the specified list, optionally with context metadata.

post/list/{listId}/entity/add

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

contextobject

Optional arbitrary key-value metadata to attach to the entity in this list. These values are stored and returned when retrieving entities via the Get Entities endpoint.

Example request

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

Response

Success

result'added' | 'updated' | 'unchanged' required

added if the entity was newly added, updated if it already existed and its context was changed, or unchanged if it already existed with the same context.