# Clickdesk Developer Docs > Official developer documentation for Clickdesk - the open-source customer support platform. Learn about our APIs, integrations, and development guidelines. ## Docs - [Create an Agent Bot](https://docs.clickdesk.openclick.ai/api-reference/account-agentbots/create-an-agent-bot.md): Criar um bot agente na conta - [Delete an AgentBot](https://docs.clickdesk.openclick.ai/api-reference/account-agentbots/delete-an-agentbot.md): Delete an AgentBot from the account - [Get an agent bot details](https://docs.clickdesk.openclick.ai/api-reference/account-agentbots/get-an-agent-bot-details.md): Get the details of an agent bot in the account - [List all AgentBots](https://docs.clickdesk.openclick.ai/api-reference/account-agentbots/list-all-agentbots.md): List all agent bots available for the current account - [Update an agent bot](https://docs.clickdesk.openclick.ai/api-reference/account-agentbots/update-an-agent-bot.md): Update an agent bot's attributes - [Create an Account User](https://docs.clickdesk.openclick.ai/api-reference/account-users/create-an-account-user.md): Criar um Usuário da Conta - [Delete an Account User](https://docs.clickdesk.openclick.ai/api-reference/account-users/delete-an-account-user.md): Delete an Account User - [List all Account Users](https://docs.clickdesk.openclick.ai/api-reference/account-users/list-all-account-users.md): Listar todos os usuários da conta - [Get account details](https://docs.clickdesk.openclick.ai/api-reference/account/get-account-details.md): Get the details of the current account - [Update account](https://docs.clickdesk.openclick.ai/api-reference/account/update-account.md): Update account details, settings, and custom attributes - [Create an Account](https://docs.clickdesk.openclick.ai/api-reference/accounts/create-an-account.md): Criar uma Conta - [Delete an Account](https://docs.clickdesk.openclick.ai/api-reference/accounts/delete-an-account.md): Delete an Account - [Get an account details](https://docs.clickdesk.openclick.ai/api-reference/accounts/get-an-account-details.md): Obter os detalhes de uma conta - [Update an account](https://docs.clickdesk.openclick.ai/api-reference/accounts/update-an-account.md): Atualizar os atributos de uma conta - [Create an Agent Bot](https://docs.clickdesk.openclick.ai/api-reference/agentbots/create-an-agent-bot.md): Create an agent bot - [Delete an AgentBot](https://docs.clickdesk.openclick.ai/api-reference/agentbots/delete-an-agentbot.md): Delete an AgentBot - [Get an agent bot details](https://docs.clickdesk.openclick.ai/api-reference/agentbots/get-an-agent-bot-details.md): Get the details of an agent bot - [List all AgentBots](https://docs.clickdesk.openclick.ai/api-reference/agentbots/list-all-agentbots.md): List all agent bots available - [Update an agent bot](https://docs.clickdesk.openclick.ai/api-reference/agentbots/update-an-agent-bot.md): Update an agent bot's attributes - [Add a New Agent](https://docs.clickdesk.openclick.ai/api-reference/agents/add-a-new-agent.md): Add a new Agent to Account - [List Agents in Account](https://docs.clickdesk.openclick.ai/api-reference/agents/list-agents-in-account.md): Get Details of Agents in an Account - [Remove an Agent from Account](https://docs.clickdesk.openclick.ai/api-reference/agents/remove-an-agent-from-account.md): Remove an Agent from Account - [Update Agent in Account](https://docs.clickdesk.openclick.ai/api-reference/agents/update-agent-in-account.md): Update an Agent in Account - [List Audit Logs in Account](https://docs.clickdesk.openclick.ai/api-reference/audit-logs/list-audit-logs-in-account.md): Get Details of Audit Log entries for an Account. This endpoint is only available in Enterprise editions and requires the audit_logs feature to be enabled. - [Add a new automation rule](https://docs.clickdesk.openclick.ai/api-reference/automation-rule/add-a-new-automation-rule.md): Add a new automation rule to account - [Get a automation rule details](https://docs.clickdesk.openclick.ai/api-reference/automation-rule/get-a-automation-rule-details.md): Get the details of a automation rule in the account - [List all automation rules in an account](https://docs.clickdesk.openclick.ai/api-reference/automation-rule/list-all-automation-rules-in-an-account.md): Get details of automation rules in an Account - [Remove a automation rule from account](https://docs.clickdesk.openclick.ai/api-reference/automation-rule/remove-a-automation-rule-from-account.md): Remove a automation rule from account - [Update automation rule in Account](https://docs.clickdesk.openclick.ai/api-reference/automation-rule/update-automation-rule-in-account.md): Update a automation rule in account - [Add a New Canned Response](https://docs.clickdesk.openclick.ai/api-reference/canned-responses/add-a-new-canned-response.md): Add a new Canned Response to Account - [List all Canned Responses in an Account](https://docs.clickdesk.openclick.ai/api-reference/canned-responses/list-all-canned-responses-in-an-account.md): Get Details of Canned Responses in an Account - [Remove a Canned Response from Account](https://docs.clickdesk.openclick.ai/api-reference/canned-responses/remove-a-canned-response-from-account.md): Remove a Canned Response from Account - [Update Canned Response in Account](https://docs.clickdesk.openclick.ai/api-reference/canned-responses/update-canned-response-in-account.md): Update a Canned Response in Account - [Add Labels](https://docs.clickdesk.openclick.ai/api-reference/contact-labels/add-labels.md): Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation. - [List Labels](https://docs.clickdesk.openclick.ai/api-reference/contact-labels/list-labels.md): Lists all the labels of a contact - [Create a contact](https://docs.clickdesk.openclick.ai/api-reference/contacts-api/create-a-contact.md): Create a contact - [Get a contact](https://docs.clickdesk.openclick.ai/api-reference/contacts-api/get-a-contact.md): Get the details of a contact - [Update a contact](https://docs.clickdesk.openclick.ai/api-reference/contacts-api/update-a-contact.md): Update a contact's attributes - [Contact Conversations](https://docs.clickdesk.openclick.ai/api-reference/contacts/contact-conversations.md): Get conversations associated with that contact - [Contact Filter](https://docs.clickdesk.openclick.ai/api-reference/contacts/contact-filter.md): Filter contacts with custom filter options and pagination - [Create Contact](https://docs.clickdesk.openclick.ai/api-reference/contacts/create-contact.md): Criar um novo Contato - [Delete Contact](https://docs.clickdesk.openclick.ai/api-reference/contacts/delete-contact.md): Delete a contact belonging to the account using ID - [List Contacts](https://docs.clickdesk.openclick.ai/api-reference/contacts/list-contacts.md): Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number - [Search Contacts](https://docs.clickdesk.openclick.ai/api-reference/contacts/search-contacts.md): Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number - [Show Contact](https://docs.clickdesk.openclick.ai/api-reference/contacts/show-contact.md): Get a contact belonging to the account using ID - [Update Contact](https://docs.clickdesk.openclick.ai/api-reference/contacts/update-contact.md): Update a contact belonging to the account using ID - [Assign Conversation](https://docs.clickdesk.openclick.ai/api-reference/conversation-assignments/assign-conversation.md): Assign a conversation to an agent or a team - [Create a conversation](https://docs.clickdesk.openclick.ai/api-reference/conversations-api/create-a-conversation.md): Create a conversation - [Get a single conversation](https://docs.clickdesk.openclick.ai/api-reference/conversations-api/get-a-single-conversation.md): Retrieves the details of a specific conversation - [List all conversations](https://docs.clickdesk.openclick.ai/api-reference/conversations-api/list-all-conversations.md): List all conversations for the contact - [Resolve a conversation](https://docs.clickdesk.openclick.ai/api-reference/conversations-api/resolve-a-conversation.md): Marks a conversation as resolved - [Toggle typing status](https://docs.clickdesk.openclick.ai/api-reference/conversations-api/toggle-typing-status.md): Toggles the typing status in a conversation - [Update last seen](https://docs.clickdesk.openclick.ai/api-reference/conversations-api/update-last-seen.md): Updates the last seen time of the contact in a conversation - [Add Labels](https://docs.clickdesk.openclick.ai/api-reference/conversations/add-labels.md): Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation. - [Conversation Details](https://docs.clickdesk.openclick.ai/api-reference/conversations/conversation-details.md): Get all details regarding a conversation with all messages in the conversation - [Conversations Filter](https://docs.clickdesk.openclick.ai/api-reference/conversations/conversations-filter.md): Filter conversations with custom filter options and pagination - [Conversations List](https://docs.clickdesk.openclick.ai/api-reference/conversations/conversations-list.md): List all the conversations with pagination - [Create New Conversation](https://docs.clickdesk.openclick.ai/api-reference/conversations/create-new-conversation.md): Creating a conversation in clickdesk requires a source id. - [Get Conversation Counts](https://docs.clickdesk.openclick.ai/api-reference/conversations/get-conversation-counts.md): Get open, unassigned and all Conversation counts - [List Labels](https://docs.clickdesk.openclick.ai/api-reference/conversations/list-labels.md): Lists all the labels of a conversation - [Toggle Priority](https://docs.clickdesk.openclick.ai/api-reference/conversations/toggle-priority.md): Toggles the priority of conversation - [Toggle Status](https://docs.clickdesk.openclick.ai/api-reference/conversations/toggle-status.md): Toggle the status of a conversation. Pass `status` to explicitly set the conversation state. Use `snoozed` along with `snoozed_until` to snooze a conversation until a specific time. If `snoozed_until` is omitted, the conversation is snoozed until the next reply from the contact. Regardless of the va… - [Update Conversation](https://docs.clickdesk.openclick.ai/api-reference/conversations/update-conversation.md): Update Conversation Attributes - [Update Custom Attributes](https://docs.clickdesk.openclick.ai/api-reference/conversations/update-custom-attributes.md): Updates the custom attributes of a conversation - [Get CSAT survey page](https://docs.clickdesk.openclick.ai/api-reference/csat-survey-page/get-csat-survey-page.md): Você pode redirecionar o cliente para esta URL, em vez de implementar o componente de pesquisa CSAT você mesmo. - [Add a new custom attribute](https://docs.clickdesk.openclick.ai/api-reference/custom-attributes/add-a-new-custom-attribute.md): Add a new custom attribute to account - [Get a custom attribute details](https://docs.clickdesk.openclick.ai/api-reference/custom-attributes/get-a-custom-attribute-details.md): Get the details of a custom attribute in the account - [List all custom attributes in an account](https://docs.clickdesk.openclick.ai/api-reference/custom-attributes/list-all-custom-attributes-in-an-account.md): Get details of custom attributes in an Account - [Remove a custom attribute from account](https://docs.clickdesk.openclick.ai/api-reference/custom-attributes/remove-a-custom-attribute-from-account.md): Remove a custom attribute from account - [Update custom attribute in Account](https://docs.clickdesk.openclick.ai/api-reference/custom-attributes/update-custom-attribute-in-account.md): Update a custom attribute in account - [Create a custom filter](https://docs.clickdesk.openclick.ai/api-reference/custom-filters/create-a-custom-filter.md): Create a custom filter in the account - [Delete a custom filter](https://docs.clickdesk.openclick.ai/api-reference/custom-filters/delete-a-custom-filter.md): Delete a custom filter from the account - [Get a custom filter details](https://docs.clickdesk.openclick.ai/api-reference/custom-filters/get-a-custom-filter-details.md): Get the details of a custom filter in the account - [List all custom filters](https://docs.clickdesk.openclick.ai/api-reference/custom-filters/list-all-custom-filters.md): List all custom filters in a category of a user - [Update a custom filter](https://docs.clickdesk.openclick.ai/api-reference/custom-filters/update-a-custom-filter.md): Update a custom filter's attributes - [Add a new article](https://docs.clickdesk.openclick.ai/api-reference/help-center/add-a-new-article.md): Add a new article to portal - [Add a new category](https://docs.clickdesk.openclick.ai/api-reference/help-center/add-a-new-category.md): Add a new category to portal - [Add a new portal](https://docs.clickdesk.openclick.ai/api-reference/help-center/add-a-new-portal.md): Add a new portal to account - [List all portals in an account](https://docs.clickdesk.openclick.ai/api-reference/help-center/list-all-portals-in-an-account.md): Get details of portals in an Account - [Update a portal](https://docs.clickdesk.openclick.ai/api-reference/help-center/update-a-portal.md): Update a portal to account - [Add a New Agent](https://docs.clickdesk.openclick.ai/api-reference/inboxes/add-a-new-agent.md): Add a new Agent to Inbox - [Add or remove agent bot](https://docs.clickdesk.openclick.ai/api-reference/inboxes/add-or-remove-agent-bot.md): To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null - [Create an inbox](https://docs.clickdesk.openclick.ai/api-reference/inboxes/create-an-inbox.md): You can create more than one website inbox in each account - [Get an inbox](https://docs.clickdesk.openclick.ai/api-reference/inboxes/get-an-inbox.md): Get an inbox available in the current account - [List Agents in Inbox](https://docs.clickdesk.openclick.ai/api-reference/inboxes/list-agents-in-inbox.md): Get Details of Agents in an Inbox - [List all inboxes](https://docs.clickdesk.openclick.ai/api-reference/inboxes/list-all-inboxes.md): List all inboxes available in the current account - [Remove an Agent from Inbox](https://docs.clickdesk.openclick.ai/api-reference/inboxes/remove-an-agent-from-inbox.md): Remove an Agent from Inbox - [Show Inbox Agent Bot](https://docs.clickdesk.openclick.ai/api-reference/inboxes/show-inbox-agent-bot.md): See if an agent bot is associated to the Inbox - [Update Agents in Inbox](https://docs.clickdesk.openclick.ai/api-reference/inboxes/update-agents-in-inbox.md): All agents except the one passed in params will be removed - [Update Inbox](https://docs.clickdesk.openclick.ai/api-reference/inboxes/update-inbox.md): Update an existing inbox - [Create an integration hook](https://docs.clickdesk.openclick.ai/api-reference/integrations/create-an-integration-hook.md): Create an integration hook - [Delete an Integration Hook](https://docs.clickdesk.openclick.ai/api-reference/integrations/delete-an-integration-hook.md): Delete an Integration Hook - [List all the Integrations](https://docs.clickdesk.openclick.ai/api-reference/integrations/list-all-the-integrations.md): Get the details of all Integrations available for the account - [Update an Integration Hook](https://docs.clickdesk.openclick.ai/api-reference/integrations/update-an-integration-hook.md): Update an Integration Hook - [Introdução às APIs do Clickdesk](https://docs.clickdesk.openclick.ai/api-reference/introduction.md): Aprenda como usar as APIs do Clickdesk para construir integrações, personalizar experiências de chat e gerenciar sua instalação. - [Create a message](https://docs.clickdesk.openclick.ai/api-reference/messages-api/create-a-message.md): Create a message - [List all messages](https://docs.clickdesk.openclick.ai/api-reference/messages-api/list-all-messages.md): List all messages in the conversation - [Update a message](https://docs.clickdesk.openclick.ai/api-reference/messages-api/update-a-message.md): Update a message - [Create New Message](https://docs.clickdesk.openclick.ai/api-reference/messages/create-new-message.md): Create a new message in the conversation. - [Delete a message](https://docs.clickdesk.openclick.ai/api-reference/messages/delete-a-message.md): Delete a message and it's attachments from the conversation. - [Get messages](https://docs.clickdesk.openclick.ai/api-reference/messages/get-messages.md): List all messages of a conversation - [Fetch user profile](https://docs.clickdesk.openclick.ai/api-reference/profile/fetch-user-profile.md): Get the user profile details - [Account Conversation Metrics](https://docs.clickdesk.openclick.ai/api-reference/reports/account-conversation-metrics.md): Get conversation metrics for Account - [Agent Conversation Metrics](https://docs.clickdesk.openclick.ai/api-reference/reports/agent-conversation-metrics.md): Get conversation metrics for Agent - [Get Account reports](https://docs.clickdesk.openclick.ai/api-reference/reports/get-account-reports.md): Get Account reports for a specific type, metric and date range - [Get Account reports summary](https://docs.clickdesk.openclick.ai/api-reference/reports/get-account-reports-summary.md): Get Account reports summary for a specific type and date range - [Add a New Agent](https://docs.clickdesk.openclick.ai/api-reference/teams/add-a-new-agent.md): Add a new Agent to Team - [Create a team](https://docs.clickdesk.openclick.ai/api-reference/teams/create-a-team.md): Create a team in the account - [Delete a team](https://docs.clickdesk.openclick.ai/api-reference/teams/delete-a-team.md): Delete a team from the account - [Get a team details](https://docs.clickdesk.openclick.ai/api-reference/teams/get-a-team-details.md): Get the details of a team in the account - [List Agents in Team](https://docs.clickdesk.openclick.ai/api-reference/teams/list-agents-in-team.md): Get Details of Agents in an Team - [List all teams](https://docs.clickdesk.openclick.ai/api-reference/teams/list-all-teams.md): List all teams available in the current account - [Remove an Agent from Team](https://docs.clickdesk.openclick.ai/api-reference/teams/remove-an-agent-from-team.md): Remove an Agent from Team - [Update a team](https://docs.clickdesk.openclick.ai/api-reference/teams/update-a-team.md): Update a team's attributes - [Update Agents in Team](https://docs.clickdesk.openclick.ai/api-reference/teams/update-agents-in-team.md): All agents except the one passed in params will be removed - [Create a User](https://docs.clickdesk.openclick.ai/api-reference/users/create-a-user.md): Create a User - [Delete a User](https://docs.clickdesk.openclick.ai/api-reference/users/delete-a-user.md): Delete a User - [Get an user details](https://docs.clickdesk.openclick.ai/api-reference/users/get-an-user-details.md): Get the details of an user - [Get User SSO Link](https://docs.clickdesk.openclick.ai/api-reference/users/get-user-sso-link.md): Get the sso link of a user - [Update a user](https://docs.clickdesk.openclick.ai/api-reference/users/update-a-user.md): Update a user's attributes - [Add a webhook](https://docs.clickdesk.openclick.ai/api-reference/webhooks/add-a-webhook.md): Add a webhook subscription to the account - [Delete a webhook](https://docs.clickdesk.openclick.ai/api-reference/webhooks/delete-a-webhook.md): Delete a webhook from the account - [List all webhooks](https://docs.clickdesk.openclick.ai/api-reference/webhooks/list-all-webhooks.md): List all webhooks in the account - [Update a webhook object](https://docs.clickdesk.openclick.ai/api-reference/webhooks/update-a-webhook-object.md): Update a webhook object in the account - [Bem-vindo à Documentação de Desenvolvedor do Clickdesk](https://docs.clickdesk.openclick.ai/introduction.md): Seu guia completo para instalar, configurar, desenvolver e integrar com o Clickdesk - a plataforma de atendimento ao cliente open-source. ## OpenAPI Specs - [platform_swagger](https://docs.clickdesk.openclick.ai/swagger/platform_swagger.json) - [client_swagger](https://docs.clickdesk.openclick.ai/swagger/client_swagger.json) - [other_swagger](https://docs.clickdesk.openclick.ai/swagger/other_swagger.json) - [application_swagger](https://docs.clickdesk.openclick.ai/swagger/application_swagger.json) - [openapi](https://docs.clickdesk.openclick.ai/api-reference/openapi.json)