Workspaces
Create, read, update, delete and restore your clients' workspaces.
A workspace is one of your clients in Sillage. Every integration starts by creating one: you choose its partner_workspace_id, your own ID for the client, and every other route of the API names the client with it in its path.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /api/v3/partner/workspaces | Create a client workspace: create a client workspace. |
| GET | /api/v3/partner/workspaces | List your client workspaces: browse your workspaces. |
| GET | /api/v3/partner/workspaces/{partner_workspace_id} | Get a client workspace: retrieve one workspace. |
| PATCH | /api/v3/partner/workspaces/{partner_workspace_id} | Update a client workspace: rename it, or pause or resume it. |
| DELETE | /api/v3/partner/workspaces/{partner_workspace_id} | Delete a client workspace: remove a workspace. |
| POST | /api/v3/partner/workspaces/{partner_workspace_id}/restore | Restore a deleted client workspace: bring a deleted workspace back. |
How a workspace reads
partner_workspace_idis your ID. You choose it when you create the workspace, and it must be unique among your workspaces. URL-encode it when you put it in a path.archivedmeans paused.truepauses the client (no scheduled weekly signal runs, no scheduled content, no weekly email report; data, API routes and manual runs keep working),falseresumes it.- One live workspace per domain. To cover another team or product of the same client, create a persona in the existing workspace instead: see Personas.
- Deleted workspaces can be restored. A deleted workspace stops resolving until you restore it.
- The owner gets admin access to the workspace in the Sillage app.