# Dixa API Version: beta ## Servers ``` https://dev.dixa.io ``` ## Security ### ApiKeyAuth Type: apiKey In: header Name: Authorization ## Download OpenAPI description [Dixa API](https://docs.dixa.io/_bundle/openapi/dixa-api/@beta/index.yaml) ## Analytics ### Metrics Catalogue - [GET /beta/analytics/metrics](https://docs.dixa.io/openapi/dixa-api/beta/analytics/getanalyticsmetrics.md): This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data ### Get Metric Data - [POST /beta/analytics/metrics](https://docs.dixa.io/openapi/dixa-api/beta/analytics/postanalyticsmetrics.md): Get data of a specific metric (aggregated) ### Metric Description - [GET /beta/analytics/metrics/{metricId}](https://docs.dixa.io/openapi/dixa-api/beta/analytics/getanalyticsmetricsmetricid.md): This endpoint lists all available properties of a metric to use for querying its data ### Filter values - [GET /beta/analytics/filter/{filterAttribute}](https://docs.dixa.io/openapi/dixa-api/beta/analytics/getanalyticsfilterfilterattribute.md): Get possible values to be used with a given filter attribute. Filter attributes are not metric or record specific, so one filter attribute can be used with multiple metrics/records. When a filter value is not relevant for a specific metric/record, it is simply ignored. ### Metric Records Catalogue - [GET /beta/analytics/records](https://docs.dixa.io/openapi/dixa-api/beta/analytics/getanalyticsrecords.md): This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data ### Get Metric Records Data - [POST /beta/analytics/records](https://docs.dixa.io/openapi/dixa-api/beta/analytics/postanalyticsrecords.md): Get data of specific metric records (unaggregated) ### Metric Record Description - [GET /beta/analytics/records/{recordId}](https://docs.dixa.io/openapi/dixa-api/beta/analytics/getanalyticsrecordsrecordid.md): This endpoint lists all available properties of a record to use for querying its data ## Agents ### List presence - [GET /beta/agents/presence](https://docs.dixa.io/openapi/dixa-api/beta/agents/getagentspresence.md): List the presence status for all agents/admins in an organization. ### List agents - [GET /beta/agents](https://docs.dixa.io/openapi/dixa-api/beta/agents/getagents.md): Lists all agents/admins in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned. ### Update agents - [PUT /beta/agents](https://docs.dixa.io/openapi/dixa-api/beta/agents/putagents.md): Bulk update agents/admins. ### Create agent - [POST /beta/agents](https://docs.dixa.io/openapi/dixa-api/beta/agents/postagents.md): Create an agent. ### Patch agents - [PATCH /beta/agents](https://docs.dixa.io/openapi/dixa-api/beta/agents/patchagents.md): Bulk patch agents/admins. ### List teams - [GET /beta/agents/{agentId}/teams](https://docs.dixa.io/openapi/dixa-api/beta/agents/getagentsagentidteams.md): List the teams in which the agent/admin is a member. ### Get presence - [GET /beta/agents/{agentId}/presence](https://docs.dixa.io/openapi/dixa-api/beta/agents/getagentsagentidpresence.md): Get the presence status for an agent/admin. ### Create agents - [POST /beta/agents/bulk](https://docs.dixa.io/openapi/dixa-api/beta/agents/postagentsbulk.md): Create agents in bulk. ### Get agent - [GET /beta/agents/{agentId}](https://docs.dixa.io/openapi/dixa-api/beta/agents/getagentsagentid.md): Get an agent/admin by id. ### Update agent - [PUT /beta/agents/{agentId}](https://docs.dixa.io/openapi/dixa-api/beta/agents/putagentsagentid.md): Update an agent/admin. ### Delete agent - [DELETE /beta/agents/{agentId}](https://docs.dixa.io/openapi/dixa-api/beta/agents/deleteagentsagentid.md): Downgrade an agent/admin to become an end user. ### Patch agent - [PATCH /beta/agents/{agentId}](https://docs.dixa.io/openapi/dixa-api/beta/agents/patchagentsagentid.md): Patch an agent/admin. ### Updates the working channel of an agent - [PUT /beta/agents/{agentId}/presence/working-channel](https://docs.dixa.io/openapi/dixa-api/beta/agents/putagentsagentidpresenceworking-channel.md): Updates the working channel of an agent ## End Users ### List end users - [GET /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/end-users/getendusers.md): Lists all end users in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned. Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a user use the GET /endusers/{userId} endpoint ### Update end users - [PUT /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/end-users/putendusers.md): Bulk update end users. ### Create end user - [POST /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/end-users/postendusers.md): Create an end user. ### Patch end users - [PATCH /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/end-users/patchendusers.md): Bulk patch end users. ### Create end users - [POST /beta/endusers/bulk](https://docs.dixa.io/openapi/dixa-api/beta/end-users/postendusersbulk.md): Create multiple end users in a single bulk action ### Get end user - [GET /beta/endusers/{userId}](https://docs.dixa.io/openapi/dixa-api/beta/end-users/getendusersuserid.md): Get an end user by id. ### Update end user - [PUT /beta/endusers/{userId}](https://docs.dixa.io/openapi/dixa-api/beta/end-users/putendusersuserid.md): Update an end user. ### Patch end user - [PATCH /beta/endusers/{userId}](https://docs.dixa.io/openapi/dixa-api/beta/end-users/patchendusersuserid.md): Patch an end user. ### Anonymize end user - [PATCH /beta/endusers/{userId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/end-users/patchendusersuseridanonymize.md): Request the anonymization of an end user. ### Patch end user custom attributes - [PATCH /beta/endusers/{userId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/end-users/patchendusersuseridcustom-attributes.md): Patch custom attributes of an end user ### List end user conversations - [GET /beta/endusers/{userId}/conversations](https://docs.dixa.io/openapi/dixa-api/beta/end-users/getendusersuseridconversations.md): Lists conversations requested by an end user. Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the GET /conversations/{conversationId} endpoint ### Create end user - [POST /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postendusers.md): Create an end user. ### Get end user - [GET /beta/endusers/{userId}](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getendusersuserid.md): Get an end user by id. ### List end user conversations - [GET /beta/endusers/{userId}/conversations](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getendusersuseridconversations.md): Lists conversations requested by an end user. Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the GET /conversations/{conversationId} endpoint ### Anonymize end user - [PATCH /beta/endusers/{userId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchendusersuseridanonymize.md): Request the anonymization of an end user. ### Patch end user custom attributes - [PATCH /beta/endusers/{userId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/custom-attributes/patchendusersuseridcustom-attributes.md): Patch custom attributes of an end user ## Chatbots ### Create end user - [POST /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/end-users/postendusers.md): Create an end user. ### Get end user - [GET /beta/endusers/{userId}](https://docs.dixa.io/openapi/dixa-api/beta/end-users/getendusersuserid.md): Get an end user by id. ### List end user conversations - [GET /beta/endusers/{userId}/conversations](https://docs.dixa.io/openapi/dixa-api/beta/end-users/getendusersuseridconversations.md): Lists conversations requested by an end user. Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the GET /conversations/{conversationId} endpoint ### Create end user - [POST /beta/endusers](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postendusers.md): Create an end user. ### Get end user - [GET /beta/endusers/{userId}](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getendusersuserid.md): Get an end user by id. ### List end user conversations - [GET /beta/endusers/{userId}/conversations](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getendusersuseridconversations.md): Lists conversations requested by an end user. Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the GET /conversations/{conversationId} endpoint ### Close conversation - [PUT /beta/conversations/{conversationId}/close](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidclose.md): Mark a conversation as closed by providing its id. ### Followup conversation - [PUT /beta/conversations/{conversationId}/followup](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidfollowup.md): Follow up a conversation by providing its id and expiration timestamp. ### Transfer conversation - [PUT /beta/conversations/{conversationId}/transfer/queue](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidtransferqueue.md): Transfer a conversation to a target queue. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### Create conversation - [POST /beta/conversations](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversations.md): Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. ### Import conversation - [POST /beta/conversations/import](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsimport.md): Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the message author through its attributes. For outbound messages the author is specified using the agentId field. ### Claim conversation - [PUT /beta/conversations/{conversationId}/claim](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidclaim.md): Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false ### Get queue availability - [GET /beta/queues/{queueId}/availability](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getqueuesqueueidavailability.md): Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat. ### Get the position of the conversation in its current queue - [GET /beta/queues/conversation-position/{csid}](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getqueuesconversation-positioncsid.md): Get the approximate position of a given conversation in its current queue. ### Close conversation - [PUT /beta/conversations/{conversationId}/close](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidclose.md): Mark a conversation as closed by providing its id. ### Followup conversation - [PUT /beta/conversations/{conversationId}/followup](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidfollowup.md): Follow up a conversation by providing its id and expiration timestamp. ### Transfer conversation - [PUT /beta/conversations/{conversationId}/transfer/queue](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidtransferqueue.md): Transfer a conversation to a target queue. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### Create conversation - [POST /beta/conversations](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversations.md): Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. ### Import conversation - [POST /beta/conversations/import](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsimport.md): Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the message author through its attributes. For outbound messages the author is specified using the agentId field. ### Claim conversation - [PUT /beta/conversations/{conversationId}/claim](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidclaim.md): Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### Get queue availability - [GET /beta/queues/{queueId}/availability](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueuesqueueidavailability.md): Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat. ### Get the position of the conversation in its current queue - [GET /beta/queues/conversation-position/{csid}](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueuesconversation-positioncsid.md): Get the approximate position of a given conversation in its current queue. ## Anonymization ### Anonymize end user - [PATCH /beta/endusers/{userId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/end-users/patchendusersuseridanonymize.md): Request the anonymization of an end user. ### Anonymize end user - [PATCH /beta/endusers/{userId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchendusersuseridanonymize.md): Request the anonymization of an end user. ### Anonymize conversation - [PATCH /beta/conversations/{conversationId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchconversationsconversationidanonymize.md): Request the anonymization of a conversation. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### Get anonymization status - [GET /beta/anonymization/request/{requestId}](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/getanonymizationrequestrequestid.md): Retrieve an anonymization request submitted earlier (user or conversation). ### Anonymize entity (deprecated) - [POST /beta/anonymization](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/postanonymization.md): Anonymize the requested entity (user or conversation). For a conversation to be successfully anonymized, it should be in the status closed. Otherwise, it requires forceAnonymization parameter set to true in the input body. NOTE: This endpoint is deprecated. Prefer using the anonymization endpoints of specific resources instead. ### Anonymize conversation - [PATCH /beta/conversations/{conversationId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidanonymize.md): Request the anonymization of a conversation. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ## Custom Attributes ### Patch end user custom attributes - [PATCH /beta/endusers/{userId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/end-users/patchendusersuseridcustom-attributes.md): Patch custom attributes of an end user ### Patch end user custom attributes - [PATCH /beta/endusers/{userId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/custom-attributes/patchendusersuseridcustom-attributes.md): Patch custom attributes of an end user ### Patch conversation custom attributes - [PATCH /beta/conversations/{conversationId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/custom-attributes/patchconversationsconversationidcustom-attributes.md): Patch custom attributes of a conversation ### Get custom attribute definition by id - [GET /beta/custom-attributes/{customAttributeId}](https://docs.dixa.io/openapi/dixa-api/beta/custom-attributes/getcustom-attributescustomattributeid.md): Get custom attribute in an organization by id. ### List custom attributes definitions - [GET /beta/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/custom-attributes/getcustom-attributes.md): List all custom attributes in an organization. ### Patch conversation custom attributes - [PATCH /beta/conversations/{conversationId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidcustom-attributes.md): Patch custom attributes of a conversation ## Conversations ### Close conversation - [PUT /beta/conversations/{conversationId}/close](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidclose.md): Mark a conversation as closed by providing its id. ### Followup conversation - [PUT /beta/conversations/{conversationId}/followup](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidfollowup.md): Follow up a conversation by providing its id and expiration timestamp. ### Transfer conversation - [PUT /beta/conversations/{conversationId}/transfer/queue](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidtransferqueue.md): Transfer a conversation to a target queue. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### Create conversation - [POST /beta/conversations](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversations.md): Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. ### Import conversation - [POST /beta/conversations/import](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsimport.md): Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the message author through its attributes. For outbound messages the author is specified using the agentId field. ### Claim conversation - [PUT /beta/conversations/{conversationId}/claim](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/putconversationsconversationidclaim.md): Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false ### Anonymize conversation - [PATCH /beta/conversations/{conversationId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchconversationsconversationidanonymize.md): Request the anonymization of a conversation. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### Patch conversation custom attributes - [PATCH /beta/conversations/{conversationId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/custom-attributes/patchconversationsconversationidcustom-attributes.md): Patch custom attributes of a conversation ### Anonymize conversation - [PATCH /beta/conversations/{conversationId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidanonymize.md): Request the anonymization of a conversation. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### Close conversation - [PUT /beta/conversations/{conversationId}/close](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidclose.md): Mark a conversation as closed by providing its id. ### Followup conversation - [PUT /beta/conversations/{conversationId}/followup](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidfollowup.md): Follow up a conversation by providing its id and expiration timestamp. ### Reopen conversation - [PUT /beta/conversations/{conversationId}/reopen](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidreopen.md): Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue. ### Transfer conversation - [PUT /beta/conversations/{conversationId}/transfer/queue](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidtransferqueue.md): Transfer a conversation to a target queue. ### Add internal notes - [POST /beta/conversations/{conversationId}/notes/bulk](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidnotesbulk.md): Create internal notes in a conversation by providing the conversation id. ### List internal notes - [GET /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidnotes.md): Get all internal notes for a particular conversation by providing the conversation id. ### Add internal note - [POST /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidnotes.md): Create an internal note in a conversation by providing the conversation id. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### List ratings for a conversation - [GET /beta/conversations/{conversationId}/ratings](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidratings.md): Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status "Rated". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of "Offered" and "Rated" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey. ### List organization activity log - [GET /beta/conversations/activitylog](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsactivitylog.md): List all activity logs for an organization. ### List flows - [GET /beta/conversations/flows](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsflows.md): List all conversations flows in an organization. ### Tag conversation - [PUT /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidtagstagid.md): Tag a conversation. You may only use active tags to tag conversations. ### Untag conversation - [DELETE /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/conversations/deleteconversationsconversationidtagstagid.md): Untag a conversation. You may remove active or inactive tags from a conversation. ### Bulk tag conversation - [POST /beta/conversations/{conversationId}/tags/bulk](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidtagsbulk.md): Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created. ### List tags - [GET /beta/conversations/{conversationId}/tags](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidtags.md): Get the tags for a particular conversation by providing the conversation id. ### List messages - [GET /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidmessages.md): Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of "_type": "EmailAttributes" if they are created through a webform, or "_type": "ContactFormAttributes" when created through a chat widget. ### Add message - [POST /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidmessages.md): Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. If attachments are added to the message, they will be copied and stored in Dixa. Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). Supported Markdown syntax for Markdown content: bold \\text\\, italic \text\, bold & italic \\\text\\\, strikethrough \~text\~, blockquote \> Quoted text. \n Message about quoted text, ordered list List:\n1. Item\n2. Item\n3. Item, unordered list List:\n\ Item\n\ Item\n\* Item, inline code This is \code\. Whatsapp channel: Only one attachment is allowed per WhatsApp message. Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx ### Create conversation - [POST /beta/conversations](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversations.md): Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. ### Import conversation - [POST /beta/conversations/import](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsimport.md): Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the message author through its attributes. For outbound messages the author is specified using the agentId field. ### Patch conversation custom attributes - [PATCH /beta/conversations/{conversationId}/custom-attributes](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidcustom-attributes.md): Patch custom attributes of a conversation ### Claim conversation - [PUT /beta/conversations/{conversationId}/claim](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidclaim.md): Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false ### List activity log - [GET /beta/conversations/{conversationId}/activitylog](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidactivitylog.md): Get the activity log for a conversation by providing the conversation id. ### Get conversation - [GET /beta/conversations/{conversationId}](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationid.md): Get a conversation by id. ### Link a conversation to a parent conversation - [PUT /beta/conversations/{conversationId}/link](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidlink.md): Links the specified conversation to a parent conversation with the specified link type. Limitations: * Maximum of 100 child conversations per parent * Only 1 parent per child conversation * A child conversation cannot have its own child conversations ### List linked conversations - [GET /beta/conversations/{conversationId}/linked](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidlinked.md): Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations. ### Search conversations with filters - [POST /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postsearchconversations.md): Search for conversations containing a particular text or by filter or combine them both ### List rating (deprecated) - [GET /beta/conversations/{conversationId}/rating](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidrating.md): Deprecated rating endpoint. Use '/ratings'. ### Search conversations (deprecated) - [GET /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getsearchconversations.md): NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### List messages - [GET /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/messages/getconversationsconversationidmessages.md): Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of "_type": "EmailAttributes" if they are created through a webform, or "_type": "ContactFormAttributes" when created through a chat widget. ### Add message - [POST /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/messages/postconversationsconversationidmessages.md): Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. If attachments are added to the message, they will be copied and stored in Dixa. Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). Supported Markdown syntax for Markdown content: bold \\text\\, italic \text\, bold & italic \\\text\\\, strikethrough \~text\~, blockquote \> Quoted text. \n Message about quoted text, ordered list List:\n1. Item\n2. Item\n3. Item, unordered list List:\n\ Item\n\ Item\n\* Item, inline code This is \code\. Whatsapp channel: Only one attachment is allowed per WhatsApp message. Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx ### Add internal notes - [POST /beta/conversations/{conversationId}/notes/bulk](https://docs.dixa.io/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotesbulk.md): Create internal notes in a conversation by providing the conversation id. ### List internal notes - [GET /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/internal-notes/getconversationsconversationidnotes.md): Get all internal notes for a particular conversation by providing the conversation id. ### Add internal note - [POST /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotes.md): Create an internal note in a conversation by providing the conversation id. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### List ratings for a conversation - [GET /beta/conversations/{conversationId}/ratings](https://docs.dixa.io/openapi/dixa-api/beta/ratings/getconversationsconversationidratings.md): Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status "Rated". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of "Offered" and "Rated" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey. ### List rating (deprecated) - [GET /beta/conversations/{conversationId}/rating](https://docs.dixa.io/openapi/dixa-api/beta/ratings/getconversationsconversationidrating.md): Deprecated rating endpoint. Use '/ratings'. ### Tag conversation - [PUT /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/tags/putconversationsconversationidtagstagid.md): Tag a conversation. You may only use active tags to tag conversations. ### Untag conversation - [DELETE /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/tags/deleteconversationsconversationidtagstagid.md): Untag a conversation. You may remove active or inactive tags from a conversation. ### Bulk tag conversation - [POST /beta/conversations/{conversationId}/tags/bulk](https://docs.dixa.io/openapi/dixa-api/beta/tags/postconversationsconversationidtagsbulk.md): Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created. ### List tags - [GET /beta/conversations/{conversationId}/tags](https://docs.dixa.io/openapi/dixa-api/beta/tags/getconversationsconversationidtags.md): Get the tags for a particular conversation by providing the conversation id. ### Search conversations with filters - [POST /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/search/postsearchconversations.md): Search for conversations containing a particular text or by filter or combine them both ### Search conversations (deprecated) - [GET /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/search/getsearchconversations.md): NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text. ## Ratings ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### List ratings for a conversation - [GET /beta/conversations/{conversationId}/ratings](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidratings.md): Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status "Rated". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of "Offered" and "Rated" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey. ### List rating (deprecated) - [GET /beta/conversations/{conversationId}/rating](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidrating.md): Deprecated rating endpoint. Use '/ratings'. ### Create conversation rating result - [POST /beta/conversations/{conversationId}/ratings/{ratingId}/submit](https://docs.dixa.io/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit.md): Create a rating result for a specific conversation. ### Create conversation rating offer - [POST /beta/conversations/{conversationId}/ratings/offer](https://docs.dixa.io/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer.md): Create a rating offer for a specific conversation. ### List ratings for a conversation - [GET /beta/conversations/{conversationId}/ratings](https://docs.dixa.io/openapi/dixa-api/beta/ratings/getconversationsconversationidratings.md): Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status "Rated". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of "Offered" and "Rated" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey. ### List rating (deprecated) - [GET /beta/conversations/{conversationId}/rating](https://docs.dixa.io/openapi/dixa-api/beta/ratings/getconversationsconversationidrating.md): Deprecated rating endpoint. Use '/ratings'. ## Queues ### Get queue availability - [GET /beta/queues/{queueId}/availability](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getqueuesqueueidavailability.md): Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat. ### Get the position of the conversation in its current queue - [GET /beta/queues/conversation-position/{csid}](https://docs.dixa.io/openapi/dixa-api/beta/chatbots/getqueuesconversation-positioncsid.md): Get the approximate position of a given conversation in its current queue. ### List queues - [GET /beta/queues](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueues.md): List all queues in an organization. ### Create queue - [POST /beta/queues](https://docs.dixa.io/openapi/dixa-api/beta/queues/postqueues.md): Create a queue. ### List agents - [GET /beta/queues/{queueId}/members](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueuesqueueidmembers.md): List all agents/admins that are members of a queue by providing the queue id. ### Remove agents - [DELETE /beta/queues/{queueId}/members](https://docs.dixa.io/openapi/dixa-api/beta/queues/deletequeuesqueueidmembers.md): Bulk remove agents/admins from the specified queue. ### Assign agents - [PATCH /beta/queues/{queueId}/members](https://docs.dixa.io/openapi/dixa-api/beta/queues/patchqueuesqueueidmembers.md): Assign one or more agents/admins to a given queue. ### Get queue availability - [GET /beta/queues/{queueId}/availability](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueuesqueueidavailability.md): Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat. ### Get queue - [GET /beta/queues/{queueId}](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueuesqueueid.md): Get a queue by id. ### Get the position of the conversation in its current queue - [GET /beta/queues/conversation-position/{csid}](https://docs.dixa.io/openapi/dixa-api/beta/queues/getqueuesconversation-positioncsid.md): Get the approximate position of a given conversation in its current queue. ## Messages ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### List messages - [GET /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidmessages.md): Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of "_type": "EmailAttributes" if they are created through a webform, or "_type": "ContactFormAttributes" when created through a chat widget. ### Add message - [POST /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidmessages.md): Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. If attachments are added to the message, they will be copied and stored in Dixa. Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). Supported Markdown syntax for Markdown content: bold \\text\\, italic \text\, bold & italic \\\text\\\, strikethrough \~text\~, blockquote \> Quoted text. \n Message about quoted text, ordered list List:\n1. Item\n2. Item\n3. Item, unordered list List:\n\ Item\n\ Item\n\* Item, inline code This is \code\. Whatsapp channel: Only one attachment is allowed per WhatsApp message. Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx ### Anonymize message - [PATCH /beta/conversations/{conversationId}/messages/{messageId}/anonymize](https://docs.dixa.io/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize.md): Request the anonymization of a single message in a conversation. ### List messages - [GET /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/messages/getconversationsconversationidmessages.md): Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of "_type": "EmailAttributes" if they are created through a webform, or "_type": "ContactFormAttributes" when created through a chat widget. ### Add message - [POST /beta/conversations/{conversationId}/messages](https://docs.dixa.io/openapi/dixa-api/beta/messages/postconversationsconversationidmessages.md): Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. If attachments are added to the message, they will be copied and stored in Dixa. Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). Supported Markdown syntax for Markdown content: bold \\text\\, italic \text\, bold & italic \\\text\\\, strikethrough \~text\~, blockquote \> Quoted text. \n Message about quoted text, ordered list List:\n1. Item\n2. Item\n3. Item, unordered list List:\n\ Item\n\ Item\n\* Item, inline code This is \code\. Whatsapp channel: Only one attachment is allowed per WhatsApp message. Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx ## Teams ### List teams - [GET /beta/teams](https://docs.dixa.io/openapi/dixa-api/beta/teams/getteams.md): Lists all teams in an organization. ### Create team - [POST /beta/teams](https://docs.dixa.io/openapi/dixa-api/beta/teams/postteams.md): Create a team. ### List members - [GET /beta/teams/{teamId}/agents](https://docs.dixa.io/openapi/dixa-api/beta/teams/getteamsteamidagents.md): Lists all agents/admins in a team. ### Remove members - [DELETE /beta/teams/{teamId}/agents](https://docs.dixa.io/openapi/dixa-api/beta/teams/deleteteamsteamidagents.md): Remove agents/admins from a team. ### Add members - [PATCH /beta/teams/{teamId}/agents](https://docs.dixa.io/openapi/dixa-api/beta/teams/patchteamsteamidagents.md): Add agents/admins to a team. ### List presence - [GET /beta/teams/{teamId}/presence](https://docs.dixa.io/openapi/dixa-api/beta/teams/getteamsteamidpresence.md): List the presence status of all agents/admins in a team. ### Get team - [GET /beta/teams/{teamId}](https://docs.dixa.io/openapi/dixa-api/beta/teams/getteamsteamid.md): Get a team by id. ### Delete team - [DELETE /beta/teams/{teamId}](https://docs.dixa.io/openapi/dixa-api/beta/teams/deleteteamsteamid.md): Delete a team. ## Internal Notes ### Add internal notes - [POST /beta/conversations/{conversationId}/notes/bulk](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidnotesbulk.md): Create internal notes in a conversation by providing the conversation id. ### List internal notes - [GET /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidnotes.md): Get all internal notes for a particular conversation by providing the conversation id. ### Add internal note - [POST /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidnotes.md): Create an internal note in a conversation by providing the conversation id. ### Add internal notes - [POST /beta/conversations/{conversationId}/notes/bulk](https://docs.dixa.io/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotesbulk.md): Create internal notes in a conversation by providing the conversation id. ### List internal notes - [GET /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/internal-notes/getconversationsconversationidnotes.md): Get all internal notes for a particular conversation by providing the conversation id. ### Add internal note - [POST /beta/conversations/{conversationId}/notes](https://docs.dixa.io/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotes.md): Create an internal note in a conversation by providing the conversation id. ## Tags ### Tag conversation - [PUT /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/conversations/putconversationsconversationidtagstagid.md): Tag a conversation. You may only use active tags to tag conversations. ### Untag conversation - [DELETE /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/conversations/deleteconversationsconversationidtagstagid.md): Untag a conversation. You may remove active or inactive tags from a conversation. ### Bulk tag conversation - [POST /beta/conversations/{conversationId}/tags/bulk](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postconversationsconversationidtagsbulk.md): Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created. ### List tags - [GET /beta/conversations/{conversationId}/tags](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getconversationsconversationidtags.md): Get the tags for a particular conversation by providing the conversation id. ### Tag conversation - [PUT /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/tags/putconversationsconversationidtagstagid.md): Tag a conversation. You may only use active tags to tag conversations. ### Untag conversation - [DELETE /beta/conversations/{conversationId}/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/tags/deleteconversationsconversationidtagstagid.md): Untag a conversation. You may remove active or inactive tags from a conversation. ### Bulk tag conversation - [POST /beta/conversations/{conversationId}/tags/bulk](https://docs.dixa.io/openapi/dixa-api/beta/tags/postconversationsconversationidtagsbulk.md): Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created. ### List tags - [GET /beta/conversations/{conversationId}/tags](https://docs.dixa.io/openapi/dixa-api/beta/tags/getconversationsconversationidtags.md): Get the tags for a particular conversation by providing the conversation id. ### List tags - [GET /beta/tags](https://docs.dixa.io/openapi/dixa-api/beta/tags/gettags.md): List all tags in an organization. Only active tags are returned by default. To include deactivated tags use ?includeDeactivated=true. ### Create tag - [POST /beta/tags](https://docs.dixa.io/openapi/dixa-api/beta/tags/posttags.md): Create a tag. ### Get tag - [GET /beta/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/tags/gettagstagid.md): Get a tag by id. ### Delete tag - [DELETE /beta/tags/{tagId}](https://docs.dixa.io/openapi/dixa-api/beta/tags/deletetagstagid.md): Deletes the tag and all its associations. Note that this operation is irreversible. ### Deactivate tag - [PATCH /beta/tags/{tagId}/deactivate](https://docs.dixa.io/openapi/dixa-api/beta/tags/patchtagstagiddeactivate.md): Deactivate a tag. ### Activate tag - [PATCH /beta/tags/{tagId}/activate](https://docs.dixa.io/openapi/dixa-api/beta/tags/patchtagstagidactivate.md): Activate a tag. ## Search ### Search conversations with filters - [POST /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/conversations/postsearchconversations.md): Search for conversations containing a particular text or by filter or combine them both ### Search conversations (deprecated) - [GET /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/conversations/getsearchconversations.md): NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text. ### Search conversations with filters - [POST /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/search/postsearchconversations.md): Search for conversations containing a particular text or by filter or combine them both ### Search conversations (deprecated) - [GET /beta/search/conversations](https://docs.dixa.io/openapi/dixa-api/beta/search/getsearchconversations.md): NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text. ## Contact Endpoints ### Get contact endpoint - [GET /beta/contact-endpoints/{contactEndpointId}](https://docs.dixa.io/openapi/dixa-api/beta/contact-endpoints/getcontact-endpointscontactendpointid.md): Get contact endpoint by id (email or phone number). ### List contact endpoints - [GET /beta/contact-endpoints](https://docs.dixa.io/openapi/dixa-api/beta/contact-endpoints/getcontact-endpoints.md): List all available contact endpoints in an organization. ## Webhooks ### Webhook Subscription - [GET /beta/webhooks/{webhookSubscriptionId}](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptionid.md): Get a Webhook Subscription by ID. ### Delete Webhook Subscription - [DELETE /beta/webhooks/{webhookSubscriptionId}](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/deletewebhookswebhooksubscriptionid.md): Delete a Webhook Subscription. ### Patch Webhook Subscription - [PATCH /beta/webhooks/{webhookSubscriptionId}](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/patchwebhookswebhooksubscriptionid.md): Patch a Webhook Subscription. ### List all Webhook Subscriptions - [GET /beta/webhooks](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/getwebhooks.md): List of all Webhook Subscriptions in an organization. ### Create Webhook Subscription - [POST /beta/webhooks](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/postwebhooks.md): Create a Webhook Subscription. ### Webhook Subscription Last Delivery Statuses - [GET /beta/webhooks/{webhookSubscriptionId}/delivery-status](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-status.md): Get the latest delivery statuses of a Webhook Subscription. ### Webhook Subscription Event Logs - [GET /beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}](https://docs.dixa.io/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent.md): Get the latest Webhook Subscription Event logs. ## Templates ### List templates - [GET /beta/templates](https://docs.dixa.io/openapi/dixa-api/beta/templates/gettemplates.md): Lists all templates belonging to an organization. ### Delete template - [DELETE /beta/templates/{templateId}](https://docs.dixa.io/openapi/dixa-api/beta/templates/deletetemplatestemplateid.md): Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible. ## Business Hours ### List business hours schedules - [GET /beta/business-hours/schedules](https://docs.dixa.io/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedules.md): List business hours schedules in an organization with pagination. ### Check if a business is open - [GET /beta/business-hours/schedules/{scheduleId}/status](https://docs.dixa.io/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidstatus.md): Check if a business is open either right now or at the specified timestamp. ## Knowledge ### Get collection - [GET /beta/knowledge/collections/{collectionId}](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionid.md): Get a knowledge collection by id ### Get collection catalog - [GET /beta/knowledge/collections/{collectionId}/catalog](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionidcatalog.md): Get collection catalog, including all categories and articles ### Get category - [GET /beta/knowledge/categories/{categoryId}](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryid.md): Get a knowledge category by id ### Get category translations - [GET /beta/knowledge/categories/{categoryId}/translations](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryidtranslations.md): Get the knowledge category translations ### Get article - [GET /beta/knowledge/articles/{articleId}](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleid.md): Get a knowledge article by id ### Get article translations - [GET /beta/knowledge/articles/{articleId}/translations](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleidtranslations.md): Get a knowledge article translations ### List collections - [GET /beta/knowledge/collections](https://docs.dixa.io/openapi/dixa-api/beta/knowledge/getknowledgecollections.md): Paginated list knowledge collections ## Organization ### Get organization details - [GET /beta/organization](https://docs.dixa.io/openapi/dixa-api/beta/organization/getorganization.md): Retrieves information about the organization associated with the provided API token