Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Inbox Views

Lists all views for a chatbot

get

Required Permission: chatbots.inbox.views.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

Responses
200

List of all views.

application/json
errorstringOptional

Optional error message.

get/v1/inbox/{chatbotId}/views
GET /v1/inbox/{chatbotId}/views HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "views": [
    {
      "id": "U0LXi1GyLR2Nj11Nt43J",
      "created": "2025-10-07T14:00:00Z",
      "updated": "2025-10-07T14:05:00Z",
      "name": "My VIP customers",
      "icon": "star",
      "tags": [
        "XxFnGrkfHcrAFLXK9vMv"
      ],
      "unread": false,
      "sorting": "updated",
      "selfAssigned": false,
      "open": true,
      "closed": false,
      "inProgress": true,
      "sortingDirection": 1
    }
  ],
  "error": "text"
}

Creates a new view

post

Required Permission: chatbots.inbox.views.create

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

Body
namestringRequired

The name of the view.

Example: Urgent requests
iconstringRequired

The name of the icon for the view.

Example: priority_high
tagsstring[]Required

A list of tag IDs for filtering.

Default: []
unreadbooleanRequired

Display only unread conversations.

Default: false
sortingstringRequired

Sort field (e.g., "created", "updated").

Example: updated
selfAssignedbooleanRequired

Display only self-assigned conversations.

Default: false
openbooleanRequired

Display open conversations.

Default: true
closedbooleanRequired

Display closed conversations.

Default: true
inProgressbooleanRequired

Display conversations in progress.

Default: true
sortingDirectionnumber · enumRequired

Sort direction

  • 0: ASC
  • 1: DESC
Possible values:
Responses
201

View created successfully.

application/json
errorstringOptional

Optional error message.

post/v1/inbox/{chatbotId}/views
POST /v1/inbox/{chatbotId}/views HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "name": "Urgent requests",
  "icon": "priority_high",
  "tags": [
    "text"
  ],
  "unread": false,
  "sorting": "updated",
  "selfAssigned": false,
  "open": true,
  "closed": true,
  "inProgress": true,
  "sortingDirection": 1
}
{
  "view": {
    "id": "U0LXi1GyLR2Nj11Nt43J",
    "created": "2025-10-07T14:00:00Z",
    "updated": "2025-10-07T14:05:00Z",
    "name": "My VIP customers",
    "icon": "star",
    "tags": [
      "XxFnGrkfHcrAFLXK9vMv"
    ],
    "unread": false,
    "sorting": "updated",
    "selfAssigned": false,
    "open": true,
    "closed": false,
    "inProgress": true,
    "sortingDirection": 1
  },
  "error": "text"
}

Retrieves a specific view

get

Required Permission: chatbots.inbox.views.get

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

viewIdstringRequired

The ID of the view

Responses
200

View details.

application/json
errorstringOptional

Optional error message.

get/v1/inbox/{chatbotId}/views/{viewId}
GET /v1/inbox/{chatbotId}/views/{viewId} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "view": {
    "id": "U0LXi1GyLR2Nj11Nt43J",
    "created": "2025-10-07T14:00:00Z",
    "updated": "2025-10-07T14:05:00Z",
    "name": "My VIP customers",
    "icon": "star",
    "tags": [
      "XxFnGrkfHcrAFLXK9vMv"
    ],
    "unread": false,
    "sorting": "updated",
    "selfAssigned": false,
    "open": true,
    "closed": false,
    "inProgress": true,
    "sortingDirection": 1
  },
  "error": "text"
}

Updates an existing view

put

Required Permission: chatbots.inbox.views.edit

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

viewIdstringRequired

The ID of the view to update

Body
namestringRequired

The name of the view.

Example: Urgent requests
iconstringRequired

The name of the icon for the view.

Example: priority_high
tagsstring[]Required

A list of tag IDs for filtering.

Default: []
unreadbooleanRequired

Display only unread conversations.

Default: false
sortingstringRequired

Sort field (e.g., "created", "updated").

Example: updated
selfAssignedbooleanRequired

Display only self-assigned conversations.

Default: false
openbooleanRequired

Display open conversations.

Default: true
closedbooleanRequired

Display closed conversations.

Default: true
inProgressbooleanRequired

Display conversations in progress.

Default: true
sortingDirectionnumber · enumRequired

Sort direction

  • 0: ASC
  • 1: DESC
Possible values:
Responses
200

View updated successfully.

application/json
errorstringOptional

Optional error message.

put/v1/inbox/{chatbotId}/views/{viewId}
PUT /v1/inbox/{chatbotId}/views/{viewId} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "name": "Urgent requests",
  "icon": "priority_high",
  "tags": [
    "text"
  ],
  "unread": false,
  "sorting": "updated",
  "selfAssigned": false,
  "open": true,
  "closed": true,
  "inProgress": true,
  "sortingDirection": 1
}
{
  "view": {
    "id": "U0LXi1GyLR2Nj11Nt43J",
    "created": "2025-10-07T14:00:00Z",
    "updated": "2025-10-07T14:05:00Z",
    "name": "My VIP customers",
    "icon": "star",
    "tags": [
      "XxFnGrkfHcrAFLXK9vMv"
    ],
    "unread": false,
    "sorting": "updated",
    "selfAssigned": false,
    "open": true,
    "closed": false,
    "inProgress": true,
    "sortingDirection": 1
  },
  "error": "text"
}

Deletes a view

delete

Required Permission: chatbots.inbox.views.delete

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

viewIdstringRequired

The ID of the view to delete

Responses
200

View deleted successfully.

No content
delete/v1/inbox/{chatbotId}/views/{viewId}
DELETE /v1/inbox/{chatbotId}/views/{viewId} HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

No content

Lists conversations for a view

get

Required Permission: chatbots.conversations.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

viewIdstringRequired

The ID of the view

Query parameters
limitnumberRequired
pageTokenstringRequired
Responses
200

List of conversations for the view.

application/json
nextPageTokenstringOptional

Token for the next page of results.

Example: eyJsYXN0SWQiOiJVMExYaTFHeUxSMk5qMTFOdDQzSiJ9
errorstringOptional

Optional error message.

get/v1/inbox/{chatbotId}/views/{viewId}/conversations
GET /v1/inbox/{chatbotId}/views/{viewId}/conversations?limit=1&pageToken=text HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "conversations": [
    {
      "id": "conv_abc123xyz",
      "contactId": "contact_def456",
      "archived": false,
      "channelId": "channel_ghi789",
      "channelType": "whatsapp",
      "chatbotId": "bot_jkl012",
      "idToken": "token_mno345",
      "language": "DE",
      "operatorId": "op_pqr678",
      "photoUrl": "https://example.com/photos/user123.jpg",
      "sessionCount": 3,
      "tags": [
        "vip",
        "sales"
      ],
      "unread": true,
      "variables": {
        "customer_name": "John",
        "order_id": "12345"
      },
      "lastBlock": {
        "id": "blk_abc123",
        "name": "Welcome Message"
      },
      "lastButton": {
        "id": "blk_abc123",
        "name": "Welcome Message"
      },
      "created": "2025-10-05T10:00:00Z",
      "updated": "2025-10-05T12:30:00Z",
      "providerId": "wa_123456789",
      "name": "John Doe",
      "lastMessage": {
        "text": "text",
        "file": {
          "name": "text",
          "url": "text",
          "type": "text",
          "mimeType": "text",
          "size": 1,
          "attachmentRef": "text",
          "caption": "text",
          "transcript": "text"
        },
        "buttons": {
          "buttons": [
            {
              "label": "text",
              "type": "text",
              "value": "text",
              "payload": "text"
            }
          ]
        },
        "selectedButton": {
          "label": "text",
          "value": "text",
          "payload": "text",
          "type": "text",
          "reference": "text"
        },
        "template": {
          "body": "text",
          "header": "text",
          "footer": "text"
        },
        "contact": {
          "addresses": [
            {
              "city": "text",
              "country": "text",
              "countryCode": "text",
              "street": "text",
              "type": "text",
              "zip": "text"
            }
          ],
          "emails": [
            {
              "email": "name@gmail.com",
              "type": "text"
            }
          ],
          "name": {
            "firstName": "text",
            "formattedName": "text",
            "lastName": "text"
          },
          "org": {
            "company": "text",
            "title": "text"
          },
          "phones": [
            {
              "phone": "text",
              "type": "text",
              "waId": "text"
            }
          ]
        },
        "location": {
          "latitude": 1,
          "longitude": 1
        },
        "note": {
          "text": "text",
          "mentions": [
            "text"
          ]
        },
        "voiceHangup": {
          "reason": "text",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "voiceTransfer": {
          "target": "text",
          "reason": "text",
          "headers": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "agentHandover": {
          "reason": "text",
          "timeoutSeconds": 1,
          "agentId": "text",
          "groupId": "text",
          "assignmentMethod": "text"
        },
        "email": {
          "subject": "text",
          "body": "text",
          "from": "text",
          "to": [
            "text"
          ],
          "cc": [
            "text"
          ],
          "bcc": [
            "text"
          ],
          "attachmentIds": [
            "text"
          ],
          "references": [
            "text"
          ],
          "attachments": [
            {
              "id": "att_123",
              "name": "invoice.pdf",
              "created": "2024-01-01T00:00:00Z",
              "updated": "2024-01-01T00:00:00Z",
              "size": 102400,
              "contentType": "application/pdf",
              "selfLink": "bucketId-objectId/filename.filetype",
              "metadata": {
                "source": "email"
              }
            }
          ]
        },
        "transcription": {
          "text": "text",
          "language": "text",
          "audioRef": "text"
        },
        "textToSpeech": {
          "text": "text",
          "speech": "text"
        },
        "reaction": {
          "reactionToMid": "text",
          "action": "text",
          "reaction": "text",
          "emoji": "text"
        },
        "callSettings": {
          "userInputSpeechDetectionTimeout": 1,
          "dtmf": true,
          "bargeIn": true
        },
        "metaWhatsappTemplate": {
          "templateName": "order_shipped_notification",
          "language": "DE",
          "bodyText": "Your order {{1}} has been shipped.",
          "headerText": "text",
          "footerText": "text",
          "header": {
            "file": {
              "name": "header_image.png",
              "url": "https://storage.example.com/files/header.png",
              "type": "image",
              "mimeType": "image/png",
              "size": 51200,
              "attachmentRef": "att_header123"
            },
            "parameters": [
              "Order #12345"
            ]
          },
          "bodyParameters": [
            "#12345"
          ],
          "buttons": [
            {
              "label": "Track Order",
              "type": "URL",
              "url": "https://example.com/track/{{1}}",
              "value": "track_order"
            }
          ]
        },
        "operator": {
          "operatorId": "op_abc123xyz"
        },
        "delay": 1,
        "leadAiId": "text"
      },
      "snoozed": "2025-10-06T09:00:00Z",
      "lastUserAction": "2025-10-05T12:25:00Z",
      "mentions": [
        "user_123",
        "user_456"
      ],
      "mentionsRead": {
        "user_123": true,
        "user_456": false
      },
      "notes": {
        "notes": [
          "Customer prefers email contact",
          "VIP customer"
        ]
      },
      "lastSender": "user",
      "userInput": {
        "redirect": "flow_abc123",
        "isSensitive": false
      },
      "environment": "test",
      "metadata": {
        "source": "website",
        "campaign": "summer_sale"
      },
      "lastUserInput": "I need help with my order",
      "leadAiConversation": {
        "flowId": "flow_xyz789",
        "stepId": "step_abc123",
        "interactions": 5,
        "executionId": "exec_def456"
      },
      "team": {
        "teamId": "team_support_01"
      },
      "state": 0,
      "lastAssignedOperatorId": "op_xyz789",
      "lastSeen": "2025-10-05T12:30:00Z"
    }
  ],
  "nextPageToken": "eyJsYXN0SWQiOiJVMExYaTFHeUxSMk5qMTFOdDQzSiJ9",
  "error": "text"
}

Gets the conversation count for a view

get

Required Permission: chatbots.conversations.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot

viewIdstringRequired

The ID of the view

Responses
200

The conversation count for the view.

application/json
countnumberRequired

The number of conversations in the view.

Example: 42
get/v1/inbox/{chatbotId}/views/{viewId}/count
GET /v1/inbox/{chatbotId}/views/{viewId}/count HTTP/1.1
Host: api.chatcaptain.com
x-chatcaptain-key: YOUR_API_KEY
Accept: */*

{
  "count": 42
}
PreviousInbox TeamsNextInbox Widgets

Last updated