PATCH
/
v3
/
workspaces
/
{workspaceId}
Update Workspace
curl --request PATCH \
  --url http://127.0.0.1:3333/v3/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": "<string>",
  "autoRechargeEnabled": true,
  "autoRechargeTrigger": 1,
  "autoRechargeAmount": 501,
  "billingCurrency": "brl"
}
'
{
  "workspace": {
    "id": "<string>",
    "name": "<string>",
    "icon": "<string>",
    "plan": "HOBBY",
    "stripeId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "creditsRecurring": 0,
    "creditsPurchased": 0,
    "billingStrategy": "PREPAID",
    "overageCapAmount": 123,
    "autoRechargeEnabled": false,
    "autoRechargeTrigger": 0,
    "autoRechargeAmount": 0,
    "billingCurrency": "brl",
    "resolvedCreditsLimit": 123,
    "resolvedSeatsLimit": 123,
    "resolvedStorageLimit": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Body

application/json
name
string
icon
string
autoRechargeEnabled
boolean
autoRechargeTrigger
number
Required range: x >= 0
autoRechargeAmount
number
Required range: x >= 500
billingCurrency
enum<string> | null
Available options:
brl,
usd,
eur,
gbp

Response

200 - application/json

Default Response

workspace
object
required