Add Entities

Adds members to a watchlist. Identify each entity by its linkedin_url or linkedin_handle (preferred). For company watchlists, a domain (e.g. stripe.com) is also accepted as a fallback when no LinkedIn identifier is available. Providing a domain on a people watchlist is reported as a wrong_entity_type row error. A value that is not a usable identifier is reported as invalid_identifier. Rows that do not match the watchlist kind never fail the whole request, the other entities are still added.

The call is partial-success: entities that were added appear in data, and any per-entity failures appear in errors. A 200 response means the request was accepted, always inspect errors for any that were not added. Re-adding members that are already present is safe and returns 200 with an empty data array. If no entities could be added because every one failed, the response is 422 with data: [] and errors populated.

Add entities

POST/api/v2/partner/workspaces/{partner_workspace_id}/watchlists/{kind}/{watchlist_id}/entities

Path parameters

Parameter	Type	Description
partner_workspace_id	string	Opaque workspace identifier from the partner system.
kind	string	Watchlist kind: `company` or `profile` (matches the list type).
watchlist_id	integer	Identifier of the watchlist.

Request body

Field	Type	Required	Description
entities	array	Yes	1 to 100 entities to add.
entities[].linkedin_url	string	One of	LinkedIn URL, with or without `https://` (e.g. `linkedin.com/company/openai`). Preferred identifier.
entities[].linkedin_handle	string	One of	LinkedIn handle. Preferred identifier.
entities[].domain	string	One of	Company domain (e.g. `stripe.com`). Company watchlists only, accepted as a fallback when no LinkedIn identifier is available. Not accepted on people watchlists.

Example request

curl -X POST "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/watchlists/company/128/entities" \
  -H "Authorization: Bearer $SILLAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "entities": [
        { "linkedin_url": "https://www.linkedin.com/company/openai" },
        { "linkedin_handle": "anthropic" }
      ] }'

Example response

Each entity's id is the canonical company/profile id, pass it to Remove entity. The shape follows the list kind: company lists return name and logo_url, people lists return first_name / last_name.

The response always includes both data (added members) and errors (per-entity failures). A 200 means the request was accepted. Inspect errors to identify any entities that could not be added.

{
  "data": [
    {
      "id": 901,
      "name": "OpenAI",
      "linkedin_handle": "openai",
      "linkedin_url": "https://www.linkedin.com/company/openai",
      "logo_url": "https://media.licdn.com/dms/image/openai-logo.png"
    },
    {
      "id": 902,
      "name": "Stripe",
      "linkedin_handle": null,
      "linkedin_url": null
    }
  ],
  "errors": [
    {
      "input": { "domain": "acme.com" },
      "code": "multiple_domain_matches",
      "message": "The domain matched more than one company. Provide a LinkedIn URL or handle to identify the exact company."
    }
  ]
}

Per-entity error codes

When an entity cannot be added, its failure is reported in errors rather than failing the whole request.

Code	Meaning
`multiple_domain_matches`	The domain matched more than one company. Use a LinkedIn URL or handle instead.
`apollo_failed`	The company could not be found or created from the domain provided.
`resolution_failed`	An unexpected error occurred while resolving the entity.
`wrong_entity_type`	The identifier does not match the watchlist kind: a person URL on a company watchlist, a company URL on a people watchlist, a `domain` on a people watchlist, or a handle already known as the other kind.
`invalid_identifier`	The value is not usable as an identifier, such as a `domain` without a dot or a LinkedIn URL with no handle.

Status codes

Status	Description
200	Request accepted. `data` contains newly-added members (empty if all were already present). Check `errors` for any per-entity failures.
401	The API key is missing or invalid.
403	The API key does not have access to this workspace.
404	The watchlist does not exist in this workspace.
422	Every entity failed to be added (see `errors`), or the body is invalid. Re-adding already-present members returns 200, not 422.
429	Too many requests.