Skip to main content
PUT
/
open
/
workspaces
/
{workspaceId}
Update Workspace
curl --request PUT \
  --url https://api.opnform.com/open/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Marketing Team",
  "icon": "🚀",
  "settings": {}
}'
{
  "id": 1,
  "name": "My Marketing Team",
  "icon": "🚀",
  "settings": {}
}

​
Update Workspace

Rename a workspace or change its icon.

​
Authentication & Scope

Requires the workspaces-write ability. The authenticated user must be an admin of the workspace.

​
Request

PUT /open/workspaces/{workspaceId} HTTP/1.1
Host: api.opnform.com
Content-Type: application/json
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeDescription
workspaceIdnumberNumeric identifier of the workspace.

​
Body Parameters

FieldTypeRequiredDescription
namestringYesNew name of the workspace.
emojistringNoNew emoji/icon (leave blank to clear).
Example: 
{
  "name": "Marketing Team",
  "emoji": "🚀"
}

​
Response

200 OK – Returns a confirmation plus the updated workspace object. 
{
  "message": "Workspace updated.",
  "workspace": {
    "id": 1,
    "name": "Marketing Team",
    "icon": "🚀",
    "max_file_size": 25,
    "is_readonly": false
  }
}
403 Forbidden – Token lacks workspaces-write or user lacks permission.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
number
required

Body

application/json
​
name
string

The name of the workspace.

Example:

"My Marketing Team"

​
icon
string

The emoji or icon representing the workspace.

Example:

"🚀"

​
settings
object

General settings for the workspace.

Response

Updated

​
id
number

The unique identifier for the workspace.

Example:

1

​
name
string

The name of the workspace.

Example:

"My Marketing Team"

​
icon
string

The emoji or icon representing the workspace.

Example:

"🚀"

​
settings
object

General settings for the workspace.