staqlydocs
REST APIAPI referenceAuth

Rename the workspace or change its time zone

Rename the workspace or change its time zone (admin)

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.

PATCH
/v1/workspace

Send the new name, timezone (an IANA name; an unknown zone is 422), or both. Fields left out stay as they are.

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
timezone?string

IANA time zone name

Response Body

OK

application/json
  1. response
id*string
name*string
plan*string

starter, plus, pro or business (cloud; an operator may also set a plan of their own), unlocked (Community Edition)

recovery_rotated_at*string
created_at*string
timezone*string

IANA time zone name (default UTC; the Community Edition starts in the machine's zone). Post repeats keep their local time of day in it across DST, and a schedule rule sent without tz runs in it.

curl -X PATCH 'https://staqly.example.com/v1/workspace' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "plan": "plus",  "recovery_rotated_at": "string",  "created_at": "string",  "timezone": "Europe/Warsaw"}