Update List

Updates a list's name, description and/or default_tracking_status. The list type is immutable — if you send it, it is ignored. Pass description: null to clear the description.

Update list

PUT/api/v2/partner/workspaces/{partner_workspace_id}/lists/{kind}/{list_id}

Path parameters

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

Request body

Field	Type	Description
name	string	Optional. New name, non-empty.
description	string	Optional. New description; pass `null` to clear it.
default_tracking_status	enum	Optional. `followed` or `unfollowed`. Members with their own status keep it.

Example request

curl -X PUT "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/lists/company/128" \
  -H "Authorization: Bearer $SILLAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Key competitors (EMEA)", "description": "Refocused on EMEA" }'

Example response

{
  "data": {
    "id": 128,
    "kind": "company",
    "type": "competitor",
    "name": "Key competitors (EMEA)",
    "description": "Refocused on EMEA",
    "member_count": 12,
    "bound_agent_count": 1,
    "tier": null,
    "default_tracking_status": "followed",
    "default_signal_bucket": null
  }
}

Errors

Status	Description
401	The API key is missing or invalid.
404	The list does not exist in your workspace.
422	Invalid `list_id` or request body.
429	Too many requests.