createWorkspaceMember

Add a member to the workspace

POST/v1/admin/workspace-members

Authorization

AuthorizationBearerrequired

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

Header parameters

x-workspace-idstringrequired

Workspace ID

x-multiple-integrationsstring

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.

Request body

Workspace member metadata

emailemailrequired

(email)

roleenum<string>required

Available options:"viewer","billing","developer","manager","administrator","owner"

sendEmailboolean

Response

Success

idstringrequired

userIduuid

(uuid)

emailstringrequired

createdAtstringrequired

roleenum<string>required

Available options:"viewer","billing","developer","manager","administrator","owner"

profilePicturestring

displayNamestring

(max length: 100)

Request

curl --request POST \ \
  --url https://api.botpress.cloud/v1/admin/workspace-members \
  --header 'x-workspace-id: <x-workspace-id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "",
  "role": "viewer",
  "sendEmail": false
}
'

Response

{
  "id": "string",
  "userId": "string",
  "email": "string",
  "createdAt": "string",
  "role": "viewer",
  "profilePicture": "string",
  "displayName": "string"
}