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: <api-key>' \
  --data '{
  "email": "jsmith@example.com",
  "role": "viewer"
}'
{
  "id": "<string>",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "createdAt": "<string>",
  "role": "viewer",
  "profilePicture": "<string>",
  "displayName": "<string>"
}

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.

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 length: 100