staqlydocs
REST APIAPI referenceAccounts

Add a workspace to the account

Add a workspace to the account (account owner; with billing it has no plan until a subscription starts, see GET /v1/billing trial)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/account/workspaces

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Request Body

application/json
  1. body
name*string
Lengthlength <= 100
timezone?string

IANA time zone name for the new workspace (default UTC)

Response Body

Created

application/json
  1. response
id*string
name*string
role*Role

viewer: read; editor: write, schedule and publish; admin: everything in the workspace; owner: admin who may also manage owners

Value in"owner""admin""editor""viewer"
current*boolean
curl -X POST 'https://staqly.example.com/v1/account/workspaces' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
{  "id": "string",  "name": "string",  "role": "owner",  "current": true}