SUsuprsend

Create Workspace

Changed on

Create a new workspace in your account.

post/v1/workspace/

Request

Request body

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

descriptionstring nullable

Optional workspace description.

Example request

{
  "name": "my-workspace",
  "description": "Testing workspace API"
}

Response

Workspace created. Response returns the created workspace.

uidstring

Unique workspace identifier.

slugstring

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

data_centerobject

Data center metadata associated with the workspace.

is_expiredboolean

Indicates whether the workspace has expired.

has_limit_reachedboolean

Indicates whether the workspace has reached its plan limit.

namestring

Human-readable workspace name.

descriptionstring nullable

Optional workspace description.

mode'production' | 'sandbox' | 'internal_sandbox'

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.

Example response

{
  "uid": "AbCdEfGhIjKlMnOpQr01",
  "slug": "staging",
  "name": "Staging"
}

Changes

  • 5f0169085547Revision changes
    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 400

    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      removed the success response with the status

    • warning

      the request property's maxLength was set to 40

    • info

      added the success response with the status

  • e54dd32705e8Revision changes
    • breaking

      api path removed without deprecation

    • info

      endpoint added