Skip to content
Subnoto Logo Subnoto Documentation

Update Workspace

POST
/public/workspace/update
 
curl --request POST \
  --url https://enclave.subnoto.com/public/workspace/update \
  --header 'Content-Type: application/json' \
  --data '{ "workspaceUuid": "example", "sandbox": true }'

Update a workspace’s sandbox flag. Sandbox mode is settable only via the public API: when enabled, envelopes sent from this workspace do not consume credits, do not send invitation emails, and do not produce real signatures.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
workspaceUuid
required

The UUID of the workspace to update.

string
>= 36 characters <= 36 characters
sandbox
required

If true, envelopes sent from this workspace simulate sending (no credits, no emails, no real signature). If false, sandbox mode is disabled.

boolean
Example generated
{
  "workspaceUuid": "example",
  "sandbox": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Default Response

Media type application/json
object
workspace
required
object
uuid
required

The unique identifier of the workspace.

string
name
required

The name of the workspace.

string
creationDate
required

The date and time the workspace was created (unix timestamp).

number
updateDate
required

The date and time the workspace was last updated (unix timestamp).

number
isDefault
required

Indicates whether this workspace is the default workspace for the users of the team.

boolean
colorHex
required

The color of the workspace in hexadecimal format.

string
sandbox
required

Whether this workspace is in sandbox mode.

boolean
Example generated
{
  "workspace": {
    "uuid": "example",
    "name": "example",
    "creationDate": 1,
    "updateDate": 1,
    "isDefault": true,
    "colorHex": "example",
    "sandbox": true
  }
}

400

Section titled “400 ”

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: WORKSPACE_NOT_FOUND INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example 
{
  "error": {
    "code": "WORKSPACE_NOT_FOUND"
  }
}

401

Section titled “401 ”

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHENTICATION_ERROR TUNNEL_ERROR TUNNEL_SESSION_NOT_FOUND INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example 
{
  "error": {
    "code": "AUTHENTICATION_ERROR"
  }
}

403

Section titled “403 ”

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHORIZATION_ERROR FEATURE_NOT_IN_CURRENT_PLAN INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example 
{
  "error": {
    "code": "AUTHORIZATION_ERROR"
  }
}

500

Section titled “500 ”

Default Response

Media type application/json
object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: INTERNAL_SERVER_ERROR INVALID_REQUEST_FORMAT
message
required

The error message

string
suggestion
required

A suggestion to resolve the error

string
documentationUrl
required

A URL to the documentation

string
details

Optional validation details (e.g. for INVALID_REQUEST_FORMAT)

Array<object>

Single validation issue (e.g. from request body schema)

object
path
required

JSON path to the invalid field

Array<string>
message
required

Validation error message for this field

string
requestId
required

The unique identifier of the request

string
timestamp
required

The timestamp of the response

string
path
required

The path of the request

string
Example 
{
  "error": {
    "code": "INTERNAL_SERVER_ERROR"
  }
}