GoRunner docs
Search or askSearch⌘K

Create or rename a workspace

PUT/api/embed/v1/accounts/{accountId}/workspaces/{workspaceId}

Creates a workspace by your ID, or renames it.

Needs a partner key: Authorization: Bearer gre_…, from Platform › Partner keys. Call it from your server only.

Embed · Self-hosted with an Embed license

Parameters

Path

accountIdRequired · string

Your ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain /.

workspaceIdRequired · string

Your ID for the workspace. The word default names the account’s default workspace. Renaming it never makes a second one.

Body

nameOptional · string

Up to 200 characters. Needed to create. A name another workspace has gets your ID added.

Responses

  • 200OK

    Renamed.

  • 201Created

    Created.

  • A field isn’t valid. details.field names it.

  • Creating the workspace would pass the license’s workspace limit.

  • You have no account with this ID.

  • The account is deleted. Restore it first, within 30 days.

  • 409BUSY

    Something else held what this call needs, and it gave up waiting. Nothing changed. Try again.

  • Something failed on the installation’s side. Try again.

Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 413 PAYLOAD_TOO_LARGE · 415 INVALID_CONTENT_TYPE · 429 RATE_LIMITED · 503 BUSY. See Errors.

Request

GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY"  # gre_…
ACCOUNT_ID="acct-bakery"
WORKSPACE_ID="ws-orders"

URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}workspaces/$WORKSPACE_ID"
curl -X PUT "$URL" \
  -H "Authorization: Bearer $GORUNNER_EMBED_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Orders"
  }'

Response · 201 Created

json
{
  "data": {
    "id": "ws-orders",
    "default": false,
    "name": "Orders",
    "members": 0,
    "createdAt": "2026-10-25T09:00:00Z",
    "workspaceId": "6e9a1c3f-8b2d-4a57-9e0c-3f7b5d1a8c42"
  }
}
Every field

Body

nameOptional · string

Response · 200 OK, 201 Created

dataobject
idstring or null

The partner’s workspace id; null for the default workspace.

defaultboolean
namestring
membersinteger
createdAttime
workspaceIdUUID

The installation’s own id of the workspace, for support. Elsewhere workspaceId is the partner’s id (id here).