1. API Operations
  2. Edit workspace

Deprecated

You are viewing a deprecated version of our API Reference. Please visit the up-to-date documentation.

Edit workspace

This operation edits an existing workspace.


Request

Parameters
Parameter
op
Type
string
required
true

Add a new workspace. The value is "edit_workspace".

Parameter
workspace_id
Type
integer
required
true

The ID of the workspace.

Parameter
name
Type
string
required
true

The new name of the workspace.

Parameter
description
Type
string
required
true

The new description of the workspace.

{
  "op": "edit_workspace",
  "workspace_id": 699761,
  "name": "WorkspaceName2",
  "description": "Updated description"
}

Response

Attributes
Attribute
op_status
Type
string

The status of the operation. The value can be "success" or "fail".

Attribute
error
Type
string

Error message. The value can be "invalid request" or "internal error".

Attribute
details
Type
string

Error details. Returned in case of an error.

{
  "op_status": "success"
}