Skip to main content
POST
/
v1
/
admin
/
workspace-members
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/admin/workspace-members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "email": "[email protected]",
  "role": "viewer"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "createdAt": "<string>",
  "role": "viewer",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profilePicture": "<string>",
  "displayName": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-workspace-id
string
required

Workspace ID

​
x-multiple-integrations
string

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.

Body

application/json

Workspace member metadata

​
email
string<email>
required
​
role
enum<string>
required
Available options:
viewer,
billing,
developer,
manager,
administrator,
owner

Response

Success

​
id
string
required
​
email
string
required
​
createdAt
string
required
​
role
enum<string>
required
Available options:
viewer,
billing,
developer,
manager,
administrator,
owner
​
userId
string<uuid>
​
profilePicture
string
​
displayName
string
Maximum string length: 100