Update a client workspace

Updates one of your workspaces. Send only the properties you want to change: at least one of name or archived is required. The domain of a workspace cannot be changed.

Route

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

Path parameters

Parameter	Type	Description
partner_workspace_id	string	Your own ID for the client workspace, as you chose it at creation. URL-encode it in the path.

Body parameters

Parameter	Type	Required	Default	Description
name	string	No	unchanged	New name of the workspace, 1 to 255 characters.
archived	boolean	No	unchanged	`true` pauses the client (no scheduled weekly signal runs, no scheduled content, no weekly email report; data, API routes and manual runs keep working), `false` resumes it.

true pauses the client (no scheduled weekly signal runs, no scheduled content, no weekly email report; data, API routes and manual runs keep working), false resumes it. Paused workspaces are left out of List your client workspaces unless you send include_archived=true.

Example request

curl -X PATCH "https://api.getsillage.com/api/v3/partner/workspaces/crm-4821" \
  -H "Authorization: Bearer $SILLAGE_MASTER_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "archived": true
}'

Success response

Status: 200 OK

{
  "data": {
    "partner_workspace_id": "crm-4821",
    "name": "Acme",
    "domain": "acme.com",
    "archived": true,
    "created_at": "2026-10-16T09:00:00.000Z"
  }
}

Response fields

Same shape as Get a client workspace.

Errors

Status	Meaning
401	The master key is missing or invalid.
404	No workspace found for this `partner_workspace_id`.
422	The body is missing or empty (`A JSON body is required`), the body has no updatable property (`must contain at least one of: name, archived`), `name` is empty, `archived` is not a boolean, `domain` is sent (`cannot be changed`), or a field the route does not accept is sent (for example `Unknown field: foo`). `errors` names each field. A query parameter is refused too.
429	Rate limit exceeded.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.