Skip to content

create

POST
/public/workspace/create

Create a new workspace for the API key owner’s team.

object
name
required

The name of the workspace to create.

string
>= 1 characters <= 100 characters
colorHex

The color of the workspace in hexadecimal format.

string
/^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/

Default Response

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

Default Response

object
statusCode
required

HTTP status code

number
error
required
object
code
required

The error code

string
Allowed values: AUTHENTICATION_ERROR TUNNEL_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
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

Default Response

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
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

Default Response

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
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