Skip to main content
PUT
Update a workspace-wide policy

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Path Parameters

id
string<uuid>
required

Policy ID

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
config
object
required
Example:
name
string
required

Policy name

Required string length: 1 - 255
Example:

"Engineering monthly budget"

policy_type
enum<string>
required
Available options:
budget
floor_reassignment
object

Move workspaces off this policy onto another workspace-wide policy in the same write

is_default
boolean

Cover every workspace in the account except opted_out_workspace_ids. On update, false on the current default unsets it.

keep_previous_default_workspaces
boolean

Keep workspaces that inherited the replaced default on that policy. Cannot be combined with released_floor_workspace_ids.

opted_out_workspace_ids
string<uuid>[]

Workspaces left out of a default policy

Example:
released_floor_workspace_ids
string<uuid>[]

Workspaces whose own workspace-wide policy of this type is dropped so they inherit this default

Example:
workspace_ids
string<uuid>[]

Workspaces the policy covers when it is not the default

Example:

Response

Workspace-wide policy updated

data
object
required