cURL
curl --request PUT \
--url https://api.botpress.cloud/v1/admin/workspaces/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"spendingLimit": 502.5,
"about": "<string>",
"profilePicture": "<string>",
"contactEmail": "<string>",
"website": "<string>",
"socialAccounts": [
"<string>"
],
"isPublic": true,
"handle": "<string>"
}
'import requests
url = "https://api.botpress.cloud/v1/admin/workspaces/{id}"
payload = {
"name": "<string>",
"spendingLimit": 502.5,
"about": "<string>",
"profilePicture": "<string>",
"contactEmail": "<string>",
"website": "<string>",
"socialAccounts": ["<string>"],
"isPublic": True,
"handle": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
spendingLimit: 502.5,
about: '<string>',
profilePicture: '<string>',
contactEmail: '<string>',
website: '<string>',
socialAccounts: ['<string>'],
isPublic: true,
handle: '<string>'
})
};
fetch('https://api.botpress.cloud/v1/admin/workspaces/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botpress.cloud/v1/admin/workspaces/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'spendingLimit' => 502.5,
'about' => '<string>',
'profilePicture' => '<string>',
'contactEmail' => '<string>',
'website' => '<string>',
'socialAccounts' => [
'<string>'
],
'isPublic' => true,
'handle' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.botpress.cloud/v1/admin/workspaces/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"spendingLimit\": 502.5,\n \"about\": \"<string>\",\n \"profilePicture\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"website\": \"<string>\",\n \"socialAccounts\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"handle\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.botpress.cloud/v1/admin/workspaces/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"spendingLimit\": 502.5,\n \"about\": \"<string>\",\n \"profilePicture\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"website\": \"<string>\",\n \"socialAccounts\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"handle\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botpress.cloud/v1/admin/workspaces/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"spendingLimit\": 502.5,\n \"about\": \"<string>\",\n \"profilePicture\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"website\": \"<string>\",\n \"socialAccounts\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"handle\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"botCount": 123,
"blocked": true,
"spendingLimit": 123,
"activeTrialId": "<string>",
"about": "",
"profilePicture": "",
"contactEmail": "",
"website": "",
"socialAccounts": [],
"isPublic": true,
"handle": "<string>"
}{
"id": "<string>",
"name": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"botCount": 123,
"blocked": true,
"spendingLimit": 123,
"activeTrialId": "<string>",
"about": "",
"profilePicture": "",
"contactEmail": "",
"website": "",
"socialAccounts": [],
"isPublic": true,
"handle": "<string>"
}Update workspace
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' \
--data '
{
"name": "<string>",
"spendingLimit": 502.5,
"about": "<string>",
"profilePicture": "<string>",
"contactEmail": "<string>",
"website": "<string>",
"socialAccounts": [
"<string>"
],
"isPublic": true,
"handle": "<string>"
}
'import requests
url = "https://api.botpress.cloud/v1/admin/workspaces/{id}"
payload = {
"name": "<string>",
"spendingLimit": 502.5,
"about": "<string>",
"profilePicture": "<string>",
"contactEmail": "<string>",
"website": "<string>",
"socialAccounts": ["<string>"],
"isPublic": True,
"handle": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
spendingLimit: 502.5,
about: '<string>',
profilePicture: '<string>',
contactEmail: '<string>',
website: '<string>',
socialAccounts: ['<string>'],
isPublic: true,
handle: '<string>'
})
};
fetch('https://api.botpress.cloud/v1/admin/workspaces/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botpress.cloud/v1/admin/workspaces/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'spendingLimit' => 502.5,
'about' => '<string>',
'profilePicture' => '<string>',
'contactEmail' => '<string>',
'website' => '<string>',
'socialAccounts' => [
'<string>'
],
'isPublic' => true,
'handle' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.botpress.cloud/v1/admin/workspaces/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"spendingLimit\": 502.5,\n \"about\": \"<string>\",\n \"profilePicture\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"website\": \"<string>\",\n \"socialAccounts\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"handle\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.botpress.cloud/v1/admin/workspaces/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"spendingLimit\": 502.5,\n \"about\": \"<string>\",\n \"profilePicture\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"website\": \"<string>\",\n \"socialAccounts\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"handle\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botpress.cloud/v1/admin/workspaces/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"spendingLimit\": 502.5,\n \"about\": \"<string>\",\n \"profilePicture\": \"<string>\",\n \"contactEmail\": \"<string>\",\n \"website\": \"<string>\",\n \"socialAccounts\": [\n \"<string>\"\n ],\n \"isPublic\": true,\n \"handle\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"botCount": 123,
"blocked": true,
"spendingLimit": 123,
"activeTrialId": "<string>",
"about": "",
"profilePicture": "",
"contactEmail": "",
"website": "",
"socialAccounts": [],
"isPublic": true,
"handle": "<string>"
}{
"id": "<string>",
"name": "<string>",
"ownerId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"botCount": 123,
"blocked": true,
"spendingLimit": 123,
"activeTrialId": "<string>",
"about": "",
"profilePicture": "",
"contactEmail": "",
"website": "",
"socialAccounts": [],
"isPublic": true,
"handle": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Whether the client supports bots with multiple instances of the same integration. Set to "true" to receive integration instances keyed by their alias instead of their id. This header will be removed in the future, and the API will always return multiple instances keyed by alias.
Path Parameters
Workspace ID
Body
application/json
Workspace metadata
Required string length:
1 - 64Required range:
5 <= x <= 1000Maximum array length:
5Required string length:
1 - 64Pattern:
^[0-9a-z][a-z0-9-_]+[0-9a-z]$Response
Success
Available options:
v1, v2, v3, v4 Available options:
community, team, enterprise, plus Last modified on March 20, 2026
Was this page helpful?
⌘I