> For the complete documentation index, see [llms.txt](https://docs.epic-ai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.epic-ai.com/api-dokumentation/inbox-tags.md).

# Inbox Tags

## Lists all tags for a chatbot

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

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox tags","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/tags":{"get":{"operationId":"InboxTagController_listTags[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}}],"responses":{"200":{"description":"List of all tags.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"summary":"Lists all tags for a chatbot","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.list`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"ListTagsResponseDto":{"type":"object","properties":{"tags":{"description":"The list of tags.","type":"array","items":{"$ref":"#/components/schemas/TagDto"}},"error":{"type":"string","description":"Optional error message."}},"required":["tags"]},"TagDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the tag."},"created":{"type":"string","description":"Timestamp when the tag was created."},"updated":{"type":"string","description":"Timestamp when the tag was last updated."},"name":{"type":"string","description":"The name of the tag."},"color":{"type":"string","pattern":"^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$","description":"The color of the tag as a hex code."}},"required":["id","created","updated","name","color"]}}}}
```

## Creates a new tag

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

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox tags","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/tags":{"post":{"operationId":"InboxTagController_createTag[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/CreateTagRequestDto"}}}},"responses":{"201":{"description":"Tag created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponseDto"}}}},"400":{"description":"Invalid input data."},"403":{"description":"Insufficient permissions."}},"summary":"Creates a new tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.create`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"CreateTagRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The name of the new tag."},"color":{"type":"string","description":"The color of the tag."}},"required":["name","color"]},"TagResponseDto":{"type":"object","properties":{"tag":{"description":"The tag.","nullable":true,"allOf":[{"$ref":"#/components/schemas/TagDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["tag"]},"TagDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the tag."},"created":{"type":"string","description":"Timestamp when the tag was created."},"updated":{"type":"string","description":"Timestamp when the tag was last updated."},"name":{"type":"string","description":"The name of the tag."},"color":{"type":"string","pattern":"^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$","description":"The color of the tag as a hex code."}},"required":["id","created","updated","name","color"]}}}}
```

## Retrieves a specific tag

> \
> \
> \*\*Required Permission:\*\* \`chatbots.tags.get\`\
> \
> \*\*Resource:\*\* \`chatbots/:chatbotId\`

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox tags","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/tags/{tagId}":{"get":{"operationId":"InboxTagController_getTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"tagId","required":true,"in":"path","description":"The ID of the tag to retrieve.","schema":{"type":"string"}}],"responses":{"200":{"description":"Details of the tag.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponseDto"}}}},"403":{"description":"Insufficient permissions."},"404":{"description":"Tag not found."}},"summary":"Retrieves a specific tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.get`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"TagResponseDto":{"type":"object","properties":{"tag":{"description":"The tag.","nullable":true,"allOf":[{"$ref":"#/components/schemas/TagDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["tag"]},"TagDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the tag."},"created":{"type":"string","description":"Timestamp when the tag was created."},"updated":{"type":"string","description":"Timestamp when the tag was last updated."},"name":{"type":"string","description":"The name of the tag."},"color":{"type":"string","pattern":"^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$","description":"The color of the tag as a hex code."}},"required":["id","created","updated","name","color"]}}}}
```

## Deletes a tag

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

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox tags","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/tags/{tagId}":{"delete":{"operationId":"InboxTagController_deleteTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"tagId","required":true,"in":"path","description":"The ID of the tag to delete.","schema":{"type":"string"}}],"responses":{"200":{"description":"Tag deleted successfully."},"403":{"description":"Insufficient permissions."}},"summary":"Deletes a tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.delete`\n\n**Resource:** `chatbots/:chatbotId`"}}}}
```

## Updates an existing tag

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

```json
{"openapi":"3.0.0","info":{"title":"ChatCaptain API","version":"1.0"},"tags":[{"name":"Inbox tags","description":""}],"servers":[{"url":"https://api.chatcaptain.com","description":"Production"}],"security":[{},{}],"paths":{"/v1/inbox/{chatbotId}/tags/{tagId}":{"patch":{"operationId":"InboxTagController_updateTag[1]_v1","parameters":[{"name":"chatbotId","required":true,"in":"path","description":"The ID of the chatbot.","schema":{"type":"string"}},{"name":"tagId","required":true,"in":"path","description":"The ID of the tag to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTagRequestDto"}}}},"responses":{"200":{"description":"Tag updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagResponseDto"}}}},"403":{"description":"Insufficient permissions."}},"summary":"Updates an existing tag","tags":["Inbox tags"],"description":"\n\n**Required Permission:** `chatbots.tags.edit`\n\n**Resource:** `chatbots/:chatbotId`"}}},"components":{"schemas":{"UpdateTagRequestDto":{"type":"object","properties":{"name":{"type":"string","description":"The new name of the tag."},"color":{"type":"string","description":"The new color of the tag."}},"required":["name","color"]},"TagResponseDto":{"type":"object","properties":{"tag":{"description":"The tag.","nullable":true,"allOf":[{"$ref":"#/components/schemas/TagDto"}]},"error":{"type":"string","description":"Optional error message."}},"required":["tag"]},"TagDto":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the tag."},"created":{"type":"string","description":"Timestamp when the tag was created."},"updated":{"type":"string","description":"Timestamp when the tag was last updated."},"name":{"type":"string","description":"The name of the tag."},"color":{"type":"string","pattern":"^#?([0-9A-F]{3}|[0-9A-F]{4}|[0-9A-F]{6}|[0-9A-F]{8})$","description":"The color of the tag as a hex code."}},"required":["id","created","updated","name","color"]}}}}
```