PUT
/
v1
/
admin
/
workspaces
/
{id}
cURL
curl --request PUT \
  --url https://api.botpress.cloud/v1/admin/workspaces/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <api-key>' \
  --data '{
  "name": "<string>",
  "spendingLimit": 502.5,
  "about": "<string>",
  "profilePicture": "<string>",
  "contactEmail": "<string>",
  "website": "<string>",
  "socialAccounts": [
    "<string>"
  ],
  "isPublic": true,
  "handle": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "ownerId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "botCount": 123,
  "billingVersion": "v1",
  "plan": "community",
  "blocked": true,
  "spendingLimit": 123,
  "about": "",
  "profilePicture": "",
  "contactEmail": "",
  "website": "",
  "socialAccounts": [],
  "isPublic": true,
  "handle": ""
}

Authorizations

​
Authorization
string
header
required

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

​
x-workspace-id
string
header
required

Your workspace ID.

Path Parameters

​
id
string
required

Workspace ID

Body

application/json

Workspace metadata

​
name
string
Required string length: 1 - 64
​
spendingLimit
number
Required range: 5 <= x <= 1000
​
about
string
​
profilePicture
string
​
contactEmail
string
​
website
string
​
socialAccounts
string[]
Maximum length: 5
​
isPublic
boolean
​
handle
string
Required string length: 1 - 64

Response

Success

​
id
string
required
​
name
string
required
​
ownerId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
botCount
number
required
​
billingVersion
enum<string>
required
Available options:
v1,
v2,
v3
​
plan
enum<string>
required
Available options:
community,
team,
enterprise,
plus
​
blocked
boolean
required
​
spendingLimit
number
required
​
about
string
default:""
​
profilePicture
string
default:""
​
contactEmail
string
default:""
​
website
string
default:""
​
socialAccounts
string[]
​
isPublic
boolean
​
handle
string
default:""