API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.
v2DeprecatedWorkspaces

Update a workspace

Partially update mutable workspace attributes.

Partially updates mutable workspace attributes. Only supplied fields are changed; omitted fields are left unchanged.

Update a workspace

PATCH/api/v2/partner/workspaces/{partner_workspace_id}

Path parameters

ParameterTypeDescription
partner_workspace_idstringOpaque workspace identifier from the partner system.

Request body

FieldTypeRequiredDescription
namestringNoNew display name for the workspace.
signal_batch_frequency_hoursintegerNoHow often, in hours, detected signals are batched. Must be a positive integer.

Example request

curl -X PATCH "https://api.getsillage.com/api/v2/partner/workspaces/ws_123" \
  -H "Authorization: Bearer $SILLAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Workspace (Renamed)", "signal_batch_frequency_hours": 4}'

Example response

{
  "data": {
    "id": 101,
    "name": "Acme Workspace (Renamed)",
    "domain": "acme.com",
    "is_archived": false,
    "partner_workspace_id": "ws_123"
  }
}

Response fields

FieldTypeDescription
idintegerIdentifier for the workspace.
namestringDisplay name of the workspace.
domainstring or nullPrimary domain of the end customer, or null if not set.
is_archivedbooleanWhether this workspace has been archived.
partner_workspace_idstringYour partner-side identifier, echoed back where applicable.

Errors

StatusMeaning
401The master key is missing or invalid.
403The master key is not authorized to access this resource.
404No workspace found for this partner_workspace_id.
422Invalid request body.
429Too many requests.
500An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json.

On this page