# Inbox answers

## Lists all response snippets

> \
> \
> \*\*Required Permission:\*\* \`chatbots.inbox.answers.list\`\
> \
> \*\*Resource:\*\* \`chatbots/:chatbotId\`

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox answers","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/answers":{"get":{"operationId":"InboxAnswerController_listAnswers[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all response snippets.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAnswersResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"summary":"Lists all response snippets","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.list`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"ListAnswersResponseDto":{"type":"object","properties":{"answers":{"description":"The list of answers.","type":"array","items":{"$ref":"#/components/schemas/AnswerDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["answers"]},"AnswerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the answer."},"created":{"type":"string","description":"Timestamp when the answer was created."},"updated":{"type":"string","description":"Timestamp when the answer was last updated."},"name":{"type":"string","description":"The name/title of the text snippet."},"message":{"type":"string","description":"The content of the text snippet."}},"required":["id","created","updated","name","message"]}}}}
```

## Creates a new response snippet

> \
> \
> \*\*Required Permission:\*\* \`chatbots.inbox.answers.create\`\
> \
> \*\*Resource:\*\* \`chatbots/:chatbotId\`

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox answers","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/answers":{"post":{"operationId":"InboxAnswerController_createAnswer[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnswerRequestDto"}}}},"responses":{"201":{"description":"Response snippet created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"summary":"Creates a new response snippet","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.create`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"CreateAnswerRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name/title of the text snippet."},"message":{"type":"string","description":"The content of the text snippet."}},"required":["name","message"]},"AnswerResponseDto":{"type":"object","properties":{"answer":{"description":"The answer.","nullable":true,"allOf":[{"$ref":"#/components/schemas/AnswerDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["answer"]},"AnswerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the answer."},"created":{"type":"string","description":"Timestamp when the answer was created."},"updated":{"type":"string","description":"Timestamp when the answer was last updated."},"name":{"type":"string","description":"The name/title of the text snippet."},"message":{"type":"string","description":"The content of the text snippet."}},"required":["id","created","updated","name","message"]}}}}
```

## Updates an existing response snippet

> \
> \
> \*\*Required Permission:\*\* \`chatbots.inbox.answers.edit\`\
> \
> \*\*Resource:\*\* \`chatbots/:chatbotId\`

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox answers","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/answers/{answerId}":{"put":{"operationId":"InboxAnswerController_updateAnswer[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"answerId","required":true,"in":"path","description":"The ID of the response snippet to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnswerRequestDto"}}}},"responses":{"200":{"description":"Response snippet updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"summary":"Updates an existing response snippet","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.edit`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"UpdateAnswerRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the text snippet."},"message":{"type":"string","description":"The new content of the text snippet."}},"required":["name","message"]},"AnswerResponseDto":{"type":"object","properties":{"answer":{"description":"The answer.","nullable":true,"allOf":[{"$ref":"#/components/schemas/AnswerDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["answer"]},"AnswerDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the answer."},"created":{"type":"string","description":"Timestamp when the answer was created."},"updated":{"type":"string","description":"Timestamp when the answer was last updated."},"name":{"type":"string","description":"The name/title of the text snippet."},"message":{"type":"string","description":"The content of the text snippet."}},"required":["id","created","updated","name","message"]}}}}
```

## Deletes a response snippet

> \
> \
> \*\*Required Permission:\*\* \`chatbots.inbox.answers.delete\`\
> \
> \*\*Resource:\*\* \`chatbots/:chatbotId\`

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox answers","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/answers/{answerId}":{"delete":{"operationId":"InboxAnswerController_deleteAnswer[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"answerId","required":true,"in":"path","description":"The ID of the response snippet to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Response snippet deleted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAnswerResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"summary":"Deletes a response snippet","tags":["Inbox answers"],"description":"\n\n**Required Permission:** `chatbots.inbox.answers.delete`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"DeleteAnswerResponseDto":{"type":"object","properties":{"error":{"type":"string","description":"Optional error message."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.chatcaptain.com/api/api-dokumentation/inbox-answers.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
