PATCH
/
workspaces
/
{workspace_id}
curl --request PATCH \
  --url https://app.getcensus.com/api/v1/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Workspace",
  "notification_emails": [
    "notifications@mycompany.slack.com"
  ]
}'
{
  "status": "updated",
  "data": {
    "id": 123,
    "name": "My Workspace",
    "organization_id": 1,
    "created_at": "2023-09-05T19:42:42.672Z",
    "notification_emails": [
      "notifications@mycompany.slack.com"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authorization using your Personal Access Token. Generate a new PAT on your user settings page.

Path Parameters

​
workspace_id
integer
required

ID of the workspace

Body

application/json
​
name
string
required

The name of the workspace. Must be unique within the organization.

Example:

"My Workspace"

​
notification_emails
string[]

The list of emails that will receive alerts from the workspace.

Example:
["notifications@mycompany.slack.com"]

Response

200
application/json
Successfully updated workspace details.
​
status
enum<string>
required

The outcome of the update request

Available options:
updated
Example:

"updated"

​
data
object
required

Was this page helpful?

Raise issue
Fetch authenticated workspaceDelete workspace