Rename the workspace

Rename the workspace

PATCH/api/v1/workspace

PATCH /workspace
curl -X PATCH 'https://www.unitpost.com/api/v1/workspace' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 200
{
  "object": "workspace",
  "id": "id_123",
  "name": "Example",
  "slug": "string",
  "image_url": "https://example.com"
}

Change the workspace's name. Deleting the workspace stays in the dashboard. Requires the branding:write capability.

Request body1 field
FieldTypeDescription
namerequiredstringThe workspace's new name.
Response · 200 fields5 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
namerequiredstring—
slugrequiredstring—
image_urlrequiredstring | nullThe workspace image (its avatar in the dashboard).
200400401403422

Search docs and guides

Search the docs and product guides.