Chatbot users

Lists all users of a chatbot

get

Required Permission: chatbots.users.list

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

workspaceIdanyRequired

The ID of the workspace.

Responses

200

List of users.

application/json

errorstringOptional

Optional error message.

403

Insufficient permissions.

get

/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users

HTTPcURLJavaScriptPython

GET /v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "users": [
    {
      "id": "kFf3OqjhsGK1rdAIyU4r",
      "name": "Max Mustermann",
      "email": "[e-mail]",
      "added": "2025-10-03T20:00:00Z",
      "roles": [
        "admin",
        "editor"
      ]
    }
  ],
  "error": "text"
}

Adds a user to a chatbot

post

Required Permission: chatbots.users.add

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

workspaceIdanyRequired

The ID of the workspace.

Body

application/json

userIdstringRequired

The ID of the user to be added.

Example: PmVSyFWMFYWB3xvHHwsc

Responses

201

User successfully added.

application/json

403

Insufficient permissions.

post

/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users

HTTPcURLJavaScriptPython

POST /v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "userId": "PmVSyFWMFYWB3xvHHwsc"
}

{
  "added": true,
  "error": "text"
}

Removes a user from a chatbot

delete

Required Permission: chatbots.users.remove

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

userIdstringRequired

The ID of the user to be removed.

workspaceIdanyRequired

The ID of the workspace.

Responses

200

User successfully removed.

application/json

removedbooleanOptional

Indicates whether the user was successfully removed.

Example: true

errorstringOptional

Optional error message.

403

Insufficient permissions.

delete

/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}

HTTPcURLJavaScriptPython

DELETE /v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "removed": true,
  "error": "text"
}

Assigns a role to a user for the chatbot

post

Required Permission: chatbots.users.roles.grant

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

userIdstringRequired

The Id of the user.

workspaceIdanyRequired

The ID of the workspace.

Body

application/json

rolestring · enumRequired

The role to be assigned.

Example: ChatbotEditorPossible values:

Responses

201

Role successfully assigned.

application/json

403

Insufficient permissions.

post

/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}/roles

HTTPcURLJavaScriptPython

POST /v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}/roles HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "role": "ChatbotEditor",
  "params": {
    "chatbotId": "fjQV0jxv2uI5oIaIDtvx",
    "userId": "967dgbak26dgöadw769efndp87"
  }
}

{
  "permissions": [
    {
      "name": "chatbots.users.list",
      "resource": "fjQV0jxv2uI5oIaIDtvx"
    }
  ],
  "error": "text"
}

Revokes a role from a user for the chatbot

delete

Required Permission: chatbots.users.roles.revoke

Resource: chatbots/:chatbotId

Authorizations

x-chatcaptain-key

x-chatcaptain-keystringRequired

Path parameters

chatbotIdstringRequired

The ID of the chatbot.

userIdstringRequired

The Id of the user.

rolestringRequired

The role to be revoked.

workspaceIdanyRequired

The ID of the workspace.

Body

application/json

Responses

200

Role successfully revoked.

application/json

successbooleanRequired

Indicates whether the role was successfully revoked.

Example: true

errorstringOptional

Optional error message.

403

Insufficient permissions.

delete

/v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}/roles/{role}

HTTPcURLJavaScriptPython

DELETE /v1/workspaces/{workspaceId}/chatbots/{chatbotId}/users/{userId}/roles/{role} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "params": {
    "chatbotId": "fjQV0jxv2uI5oIaIDtvx",
    "userId": "967dgbak26dgöadw769efndp87"
  }
}

{
  "success": true,
  "error": "text"
}