Plum / developers
REST APIWorkspaces

PATCH /workspaces/{id}/settings

Changes some retention buckets; omitted buckets and fields keep their value. Owners only; requires `workspace:manage`. A shared workspace’s settings need workspace sharing for your account. Turning a bucket off stops keeping its data past processing. Shortening a duration or turning a bucket off applies to existing data at the next cleanup. Each current member receives `workspace.updated`.

PATCH/workspaces/{id}/settings

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/settings" \  -H "X-API-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "retention": {}  }'
{  "success": true,  "data": {    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",    "retention": [      {        "bucket": "string",        "enabled": true,        "days": 1,        "max_days": 1,        "default_enabled": true,        "default_days": 1,        "updated_at": "2019-08-24T14:15:22Z",        "updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe"      }    ]  }}

GET /workspaces/{id}/settings GET

Reads a workspace’s settings: for each retention bucket (`audio`, `transcripts`, `insights`, `voice`), whether its data is kept, for how many days, the longest duration the plan allows (`max_days`), and the default. Any member may read them; requires `workspace:read`. A shared workspace’s settings need workspace sharing for your account; your private workspace’s do not.

Transfer workspace ownership POST

Makes another member an owner; you become an admin. Owners only; requires `workspace:manage`. Your private workspace cannot be transferred (409 `PRIVATE_WORKSPACE`). Works without workspace sharing for your account.