Create List

Creates a workspace-scoped list. Set the immutable type — the list kind (company or people) is derived from it server-side, you never declare it. A new list starts empty; add members with Add members.

Create list

POST/api/v2/partner/workspaces/{partner_workspace_id}/lists

Path parameters

Parameter	Type	Description
partner_workspace_id	string	Opaque workspace identifier from the partner system.

Request body

Field	Type	Description
type	enum	Immutable. One of `competitor`, `partner`, `customer`, `prospect` (company) or `influencer`, `champion` (people).
name	string	Display name. Required, non-empty.
description	string	Optional free-text description.
default_tracking_status	enum	`followed` or `unfollowed` — what happens to a member by default. Defaults to `followed` when omitted.

Example request

curl -X POST "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/lists" \
  -H "Authorization: Bearer $SILLAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "competitor",
    "name": "Key competitors",
    "description": "Companies we track for competitive signals"
  }'

Example response

201 Created

{
  "data": {
    "id": 128,
    "kind": "company",
    "type": "competitor",
    "name": "Key competitors",
    "description": "Companies we track for competitive signals",
    "member_count": 0,
    "bound_agent_count": 0,
    "tier": null,
    "default_tracking_status": "followed",
    "default_signal_bucket": null
  }
}

Response fields

Field	Type	Description
data.id	integer	Identifier of the list.
data.kind	string	`company` or `profile`, derived from `type`.
data.type	string	The immutable list type.
data.name	string	Display name.
data.description	string	Description, or `null`.
data.member_count	integer	Number of members.
data.bound_agent_count	integer	Number of agents bound to this list.
data.tier	integer	Tier, `customer`/`prospect` lists only. `null` on every other type.
data.default_tracking_status	string	What happens to a member by default.
data.default_signal_bucket	string	Default signal bucket, or `null`. Recorded and returned only.

Errors

Status	Description
401	The API key is missing or invalid.
422	Invalid body — unknown `type` or empty `name`.
429	Too many requests.