Skip to main content
POST
Create Workspace

Authorizations

Authorization
string
header
required

Pass as Authorization: ServiceToken <token>. You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Body

application/json
name
string
required

Workspace name, up to 40 characters (letters, numbers, spaces, _ and -). The workspace slug is derived from the name and must be unique in your account.

Maximum string length: 40
Example:

"my-workspace"

description
string | null

Optional workspace description.

Example:

"Testing workspace API"

Response

Workspace created. Response returns the created workspace.

Workspace record returned by the Management API.

uid
string

Unique workspace identifier.

Example:

"AbCdEfGhIjKlMnOpQr01"

slug
string

Workspace slug used in API paths (e.g. staging, production).

Example:

"staging"

data_center
object

Data center metadata associated with the workspace.

is_expired
boolean

Indicates whether the workspace has expired.

has_limit_reached
boolean

Indicates whether the workspace has reached its plan limit.

name
string

Human-readable workspace name.

Example:

"Staging"

description
string | null

Optional workspace description.

mode
enum<string>

Workspace mode. production sends to your actual users, sandbox means Test Mode is enabled on the workspace, and internal_sandbox is the Sandbox workspace pre-created by SuprSend for early testing with pre-configured vendors. New workspaces default to production.

Available options:
production,
sandbox,
internal_sandbox