{"items":[{"type":"link","fsPath":"openapi/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/openapi","separatorLine":true,"routeSlug":"/openapi"},{"type":"group","label":"Dixa API","items":[{"type":"link","label":"Dixa API","link":"/openapi/dixa-api/beta","routeSlug":"/openapi/dixa-api/beta","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Analytics","link":"/openapi/dixa-api/beta/analytics","routeSlug":"/openapi/dixa-api/beta/analytics","items":[{"label":"Metrics Catalogue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsmetrics","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsmetrics","metadata":{"seo":{"title":"Metrics Catalogue","description":"This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data"}},"httpPath":"/beta/analytics/metrics","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get Metric Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/postanalyticsmetrics","routeSlug":"/openapi/dixa-api/beta/analytics/postanalyticsmetrics","metadata":{"seo":{"title":"Get Metric Data","description":"Get data of a specific metric (aggregated)"}},"httpPath":"/beta/analytics/metrics","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Metric Description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsmetricsmetricid","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsmetricsmetricid","metadata":{"seo":{"title":"Metric Description","description":"This endpoint lists all available properties of a metric to use for querying its data"}},"httpPath":"/beta/analytics/metrics/{metricId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Filter values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsfilterfilterattribute","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsfilterfilterattribute","metadata":{"seo":{"title":"Filter values","description":"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."}},"httpPath":"/beta/analytics/filter/{filterAttribute}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Metric Records Catalogue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsrecords","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsrecords","metadata":{"seo":{"title":"Metric Records Catalogue","description":"This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data"}},"httpPath":"/beta/analytics/records","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get Metric Records Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/postanalyticsrecords","routeSlug":"/openapi/dixa-api/beta/analytics/postanalyticsrecords","metadata":{"seo":{"title":"Get Metric Records Data","description":"Get data of specific metric records (unaggregated)"}},"httpPath":"/beta/analytics/records","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Metric Record Description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsrecordsrecordid","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsrecordsrecordid","metadata":{"seo":{"title":"Metric Record Description","description":"This endpoint lists all available properties of a record to use for querying its data"}},"httpPath":"/beta/analytics/records/{recordId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Agents","link":"/openapi/dixa-api/beta/agents","routeSlug":"/openapi/dixa-api/beta/agents","items":[{"label":"List presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentspresence","routeSlug":"/openapi/dixa-api/beta/agents/getagentspresence","metadata":{"seo":{"title":"List presence","description":"List the presence status for all agents/admins in an organization."}},"httpPath":"/beta/agents/presence","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagents","routeSlug":"/openapi/dixa-api/beta/agents/getagents","metadata":{"seo":{"title":"List agents","description":"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."}},"httpPath":"/beta/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Update agents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/putagents","routeSlug":"/openapi/dixa-api/beta/agents/putagents","metadata":{"seo":{"title":"Update agents","description":"Bulk update agents/admins."}},"httpPath":"/beta/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/postagents","routeSlug":"/openapi/dixa-api/beta/agents/postagents","metadata":{"seo":{"title":"Create agent","description":"Create an agent."}},"httpPath":"/beta/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch agents","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/patchagents","routeSlug":"/openapi/dixa-api/beta/agents/patchagents","metadata":{"seo":{"title":"Patch agents","description":"Bulk patch agents/admins."}},"httpPath":"/beta/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentsagentidteams","routeSlug":"/openapi/dixa-api/beta/agents/getagentsagentidteams","metadata":{"seo":{"title":"List teams","description":"List the teams in which the agent/admin is a member."}},"httpPath":"/beta/agents/{agentId}/teams","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentsagentidpresence","routeSlug":"/openapi/dixa-api/beta/agents/getagentsagentidpresence","metadata":{"seo":{"title":"Get presence","description":"Get the presence status for an agent/admin."}},"httpPath":"/beta/agents/{agentId}/presence","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create agents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/postagentsbulk","routeSlug":"/openapi/dixa-api/beta/agents/postagentsbulk","metadata":{"seo":{"title":"Create agents","description":"Create agents in bulk."}},"httpPath":"/beta/agents/bulk","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/getagentsagentid","metadata":{"seo":{"title":"Get agent","description":"Get an agent/admin by id."}},"httpPath":"/beta/agents/{agentId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Update agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/putagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/putagentsagentid","metadata":{"seo":{"title":"Update agent","description":"Update an agent/admin."}},"httpPath":"/beta/agents/{agentId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/deleteagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/deleteagentsagentid","metadata":{"seo":{"title":"Delete agent","description":"Downgrade an agent/admin to become an end user."}},"httpPath":"/beta/agents/{agentId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch agent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/patchagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/patchagentsagentid","metadata":{"seo":{"title":"Patch agent","description":"Patch an agent/admin."}},"httpPath":"/beta/agents/{agentId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Updates the working channel of an agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/putagentsagentidpresenceworking-channel","routeSlug":"/openapi/dixa-api/beta/agents/putagentsagentidpresenceworking-channel","metadata":{"seo":{"title":"Updates the working channel of an agent","description":"Updates the working channel of an agent"}},"httpPath":"/beta/agents/{agentId}/presence/working-channel","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"AI Agents","link":"/openapi/dixa-api/beta/ai-agents","routeSlug":"/openapi/dixa-api/beta/ai-agents","items":[{"label":"List AI agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ai-agents/getai-agents","routeSlug":"/openapi/dixa-api/beta/ai-agents/getai-agents","metadata":{"seo":{"title":"List AI agents","description":"Lists all AI agents in an organization. AI agents include Dixa's native Mim agents and external chatbot integrations."}},"httpPath":"/beta/ai-agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"End Users","link":"/openapi/dixa-api/beta/end-users","routeSlug":"/openapi/dixa-api/beta/end-users","items":[{"label":"List end users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/getendusers","routeSlug":"/openapi/dixa-api/beta/end-users/getendusers","metadata":{"seo":{"title":"List end users","description":"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.<br/> <b>Note:</b> 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"}},"httpPath":"/beta/endusers","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Update end users","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/putendusers","routeSlug":"/openapi/dixa-api/beta/end-users/putendusers","metadata":{"seo":{"title":"Update end users","description":"Bulk update end users."}},"httpPath":"/beta/endusers","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create end user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/postendusers","routeSlug":"/openapi/dixa-api/beta/end-users/postendusers","metadata":{"seo":{"title":"Create end user","description":"Create an end user."}},"httpPath":"/beta/endusers","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch end users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusers","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusers","metadata":{"seo":{"title":"Patch end users","description":"Bulk patch end users."}},"httpPath":"/beta/endusers","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create end users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/postendusersbulk","routeSlug":"/openapi/dixa-api/beta/end-users/postendusersbulk","metadata":{"seo":{"title":"Create end users","description":"Create multiple end users in a single bulk action"}},"httpPath":"/beta/endusers/bulk","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/getendusersuserid","routeSlug":"/openapi/dixa-api/beta/end-users/getendusersuserid","metadata":{"seo":{"title":"Get end user","description":"Get an end user by id."}},"httpPath":"/beta/endusers/{userId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Update end user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/putendusersuserid","routeSlug":"/openapi/dixa-api/beta/end-users/putendusersuserid","metadata":{"seo":{"title":"Update end user","description":"Update an end user."}},"httpPath":"/beta/endusers/{userId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusersuserid","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusersuserid","metadata":{"seo":{"title":"Patch end user","description":"Patch an end user."}},"httpPath":"/beta/endusers/{userId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Anonymize end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusersuseridanonymize","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusersuseridanonymize","metadata":{"seo":{"title":"Anonymize end user","description":"Request the anonymization of an end user."}},"httpPath":"/beta/endusers/{userId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch end user custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusersuseridcustom-attributes","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusersuseridcustom-attributes","metadata":{"seo":{"title":"Patch end user custom attributes","description":"Patch custom attributes of an end user"}},"httpPath":"/beta/endusers/{userId}/custom-attributes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List end user conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/getendusersuseridconversations","routeSlug":"/openapi/dixa-api/beta/end-users/getendusersuseridconversations","metadata":{"seo":{"title":"List end user conversations","description":"Lists conversations requested by an end user. <br/> 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"}},"httpPath":"/beta/endusers/{userId}/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Chatbots","link":"/openapi/dixa-api/beta/chatbots","routeSlug":"/openapi/dixa-api/beta/chatbots","items":[{"label":"Create end user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postendusers","routeSlug":"/openapi/dixa-api/beta/chatbots/postendusers","metadata":{"seo":{"title":"Create end user","description":"Create an end user."}},"httpPath":"/beta/endusers","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getendusersuserid","routeSlug":"/openapi/dixa-api/beta/chatbots/getendusersuserid","metadata":{"seo":{"title":"Get end user","description":"Get an end user by id."}},"httpPath":"/beta/endusers/{userId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List end user conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getendusersuseridconversations","routeSlug":"/openapi/dixa-api/beta/chatbots/getendusersuseridconversations","metadata":{"seo":{"title":"List end user conversations","description":"Lists conversations requested by an end user. <br/> 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"}},"httpPath":"/beta/endusers/{userId}/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Close conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclose","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclose","metadata":{"seo":{"title":"Close conversation","description":"Mark a conversation as closed by providing its id."}},"httpPath":"/beta/conversations/{conversationId}/close","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Followup conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidfollowup","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidfollowup","metadata":{"seo":{"title":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp."}},"httpPath":"/beta/conversations/{conversationId}/followup","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Transfer conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidtransferqueue","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidtransferqueue","metadata":{"seo":{"title":"Transfer conversation","description":"Transfer a conversation to a target queue."}},"httpPath":"/beta/conversations/{conversationId}/transfer/queue","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"httpPath":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"httpPath":"/beta/conversations/{conversationId}/ratings/offer","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversations","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversations","metadata":{"seo":{"title":"Create conversation","description":"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."}},"httpPath":"/beta/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Import conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversationsimport","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversationsimport","metadata":{"seo":{"title":"Import conversation","description":"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."}},"httpPath":"/beta/conversations/import","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Claim conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclaim","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclaim","metadata":{"seo":{"title":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false"}},"httpPath":"/beta/conversations/{conversationId}/claim","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get queue availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getqueuesqueueidavailability","routeSlug":"/openapi/dixa-api/beta/chatbots/getqueuesqueueidavailability","metadata":{"seo":{"title":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."}},"httpPath":"/beta/queues/{queueId}/availability","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get the position of the conversation in its current queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getqueuesconversation-positioncsid","routeSlug":"/openapi/dixa-api/beta/chatbots/getqueuesconversation-positioncsid","metadata":{"seo":{"title":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue."}},"httpPath":"/beta/queues/conversation-position/{csid}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Anonymization","link":"/openapi/dixa-api/beta/anonymization","routeSlug":"/openapi/dixa-api/beta/anonymization","items":[{"label":"Anonymize end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/patchendusersuseridanonymize","routeSlug":"/openapi/dixa-api/beta/anonymization/patchendusersuseridanonymize","metadata":{"seo":{"title":"Anonymize end user","description":"Request the anonymization of an end user."}},"httpPath":"/beta/endusers/{userId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Anonymize conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidanonymize","routeSlug":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidanonymize","metadata":{"seo":{"title":"Anonymize conversation","description":"Request the anonymization of a conversation."}},"httpPath":"/beta/conversations/{conversationId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"httpPath":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get anonymization status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/getanonymizationrequestrequestid","routeSlug":"/openapi/dixa-api/beta/anonymization/getanonymizationrequestrequestid","metadata":{"seo":{"title":"Get anonymization status","description":"Retrieve an anonymization request submitted earlier (user or conversation)."}},"httpPath":"/beta/anonymization/request/{requestId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Anonymize entity","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/postanonymization","routeSlug":"/openapi/dixa-api/beta/anonymization/postanonymization","metadata":{"seo":{"title":"Anonymize entity","description":"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."}},"httpPath":"/beta/anonymization","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Custom Attributes","link":"/openapi/dixa-api/beta/custom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes","items":[{"label":"Patch end user custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/patchendusersuseridcustom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes/patchendusersuseridcustom-attributes","metadata":{"seo":{"title":"Patch end user custom attributes","description":"Patch custom attributes of an end user"}},"httpPath":"/beta/endusers/{userId}/custom-attributes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch conversation custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/patchconversationsconversationidcustom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes/patchconversationsconversationidcustom-attributes","metadata":{"seo":{"title":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation"}},"httpPath":"/beta/conversations/{conversationId}/custom-attributes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get custom attribute definition by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributescustomattributeid","routeSlug":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributescustomattributeid","metadata":{"seo":{"title":"Get custom attribute definition by id","description":"Get custom attribute in an organization by id."}},"httpPath":"/beta/custom-attributes/{customAttributeId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List custom attributes definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributes","metadata":{"seo":{"title":"List custom attributes definitions","description":"List all custom attributes in an organization."}},"httpPath":"/beta/custom-attributes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Teams","link":"/openapi/dixa-api/beta/teams","routeSlug":"/openapi/dixa-api/beta/teams","items":[{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteams","routeSlug":"/openapi/dixa-api/beta/teams/getteams","metadata":{"seo":{"title":"List teams","description":"Lists all teams in an organization."}},"httpPath":"/beta/teams","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/postteams","routeSlug":"/openapi/dixa-api/beta/teams/postteams","metadata":{"seo":{"title":"Create team","description":"Create a team."}},"httpPath":"/beta/teams","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteamsteamidagents","routeSlug":"/openapi/dixa-api/beta/teams/getteamsteamidagents","metadata":{"seo":{"title":"List members","description":"Lists all agents/admins in a team."}},"httpPath":"/beta/teams/{teamId}/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Remove members","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/deleteteamsteamidagents","routeSlug":"/openapi/dixa-api/beta/teams/deleteteamsteamidagents","metadata":{"seo":{"title":"Remove members","description":"Remove agents/admins from a team."}},"httpPath":"/beta/teams/{teamId}/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Add members","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/patchteamsteamidagents","routeSlug":"/openapi/dixa-api/beta/teams/patchteamsteamidagents","metadata":{"seo":{"title":"Add members","description":"Add agents/admins to a team."}},"httpPath":"/beta/teams/{teamId}/agents","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteamsteamidpresence","routeSlug":"/openapi/dixa-api/beta/teams/getteamsteamidpresence","metadata":{"seo":{"title":"List presence","description":"List the presence status of all agents/admins in a team."}},"httpPath":"/beta/teams/{teamId}/presence","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteamsteamid","routeSlug":"/openapi/dixa-api/beta/teams/getteamsteamid","metadata":{"seo":{"title":"Get team","description":"Get a team by id."}},"httpPath":"/beta/teams/{teamId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/deleteteamsteamid","routeSlug":"/openapi/dixa-api/beta/teams/deleteteamsteamid","metadata":{"seo":{"title":"Delete team","description":"Delete a team."}},"httpPath":"/beta/teams/{teamId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Conversations","link":"/openapi/dixa-api/beta/conversations","routeSlug":"/openapi/dixa-api/beta/conversations","items":[{"label":"Anonymize conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidanonymize","routeSlug":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidanonymize","metadata":{"seo":{"title":"Anonymize conversation","description":"Request the anonymization of a conversation."}},"httpPath":"/beta/conversations/{conversationId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"httpPath":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Close conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclose","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclose","metadata":{"seo":{"title":"Close conversation","description":"Mark a conversation as closed by providing its id."}},"httpPath":"/beta/conversations/{conversationId}/close","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Followup conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidfollowup","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidfollowup","metadata":{"seo":{"title":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp."}},"httpPath":"/beta/conversations/{conversationId}/followup","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Reopen conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidreopen","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidreopen","metadata":{"seo":{"title":"Reopen conversation","description":"Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue."}},"httpPath":"/beta/conversations/{conversationId}/reopen","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Transfer conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtransferqueue","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtransferqueue","metadata":{"seo":{"title":"Transfer conversation","description":"Transfer a conversation to a target queue."}},"httpPath":"/beta/conversations/{conversationId}/transfer/queue","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Add internal notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotesbulk","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotesbulk","metadata":{"seo":{"title":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/notes/bulk","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List internal notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidnotes","metadata":{"seo":{"title":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/notes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Add internal note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotes","metadata":{"seo":{"title":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/notes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"httpPath":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"httpPath":"/beta/conversations/{conversationId}/ratings/offer","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List ratings for a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidratings","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidratings","metadata":{"seo":{"title":"List ratings for a conversation","description":"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."}},"httpPath":"/beta/conversations/{conversationId}/ratings","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List organization activity log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsactivitylog","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsactivitylog","metadata":{"seo":{"title":"List organization activity log","description":"List all activity logs for an organization."}},"httpPath":"/beta/conversations/activitylog","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List flows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsflows","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsflows","metadata":{"seo":{"title":"List flows","description":"List all conversations flows in an organization."}},"httpPath":"/beta/conversations/flows","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Tag conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtagstagid","metadata":{"seo":{"title":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations."}},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Untag conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/deleteconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/conversations/deleteconversationsconversationidtagstagid","metadata":{"seo":{"title":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation."}},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Bulk tag conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidtagsbulk","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidtagsbulk","metadata":{"seo":{"title":"Bulk tag conversation","description":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."}},"httpPath":"/beta/conversations/{conversationId}/tags/bulk","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidtags","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidtags","metadata":{"seo":{"title":"List tags","description":"Get the tags for a particular conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/tags","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidmessages","metadata":{"seo":{"title":"List messages","description":"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."}},"httpPath":"/beta/conversations/{conversationId}/messages","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Add message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidmessages","metadata":{"seo":{"title":"Add message","description":"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. <br>If attachments are added to the message, they will be copied and stored in Dixa. <br> Content in outbound message is required except for Whatsapp messages. <br> Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). <br><br> Supported Markdown syntax for Markdown content: bold <code>**text**</code>, italic <code>*text*</code>, bold & italic <code>***text***</code>, strikethrough <code>~text~</code>, blockquote <code> > Quoted text. \\n Message about quoted text</code>, ordered list <code>List:\\n1. Item\\n2. Item\\n3. Item</code>, unordered list <code>List:\\n* Item\\n* Item\\n* Item</code>, inline code <code>This is `code`</code>. <br><br> Whatsapp channel: <br> Only one attachment is allowed per WhatsApp message. <br> Supports adding a message with attachment only (no content). <br> Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"}},"httpPath":"/beta/conversations/{conversationId}/messages","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversations","routeSlug":"/openapi/dixa-api/beta/conversations/postconversations","metadata":{"seo":{"title":"Create conversation","description":"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."}},"httpPath":"/beta/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Import conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsimport","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsimport","metadata":{"seo":{"title":"Import conversation","description":"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."}},"httpPath":"/beta/conversations/import","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch conversation custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidcustom-attributes","routeSlug":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidcustom-attributes","metadata":{"seo":{"title":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation"}},"httpPath":"/beta/conversations/{conversationId}/custom-attributes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Claim conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclaim","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclaim","metadata":{"seo":{"title":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false"}},"httpPath":"/beta/conversations/{conversationId}/claim","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List activity log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidactivitylog","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidactivitylog","metadata":{"seo":{"title":"List activity log","description":"Get the activity log for a conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/activitylog","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationid","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationid","metadata":{"seo":{"title":"Get conversation","description":"Get a conversation by id."}},"httpPath":"/beta/conversations/{conversationId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Link a conversation to a parent conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidlink","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidlink","metadata":{"seo":{"title":"Link a conversation to a parent conversation","description":"Links the specified conversation to a parent conversation with the specified link type."}},"httpPath":"/beta/conversations/{conversationId}/link","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List linked conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidlinked","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidlinked","metadata":{"seo":{"title":"List linked conversations","description":"Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations."}},"httpPath":"/beta/conversations/{conversationId}/linked","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Search conversations with filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postsearchconversations","routeSlug":"/openapi/dixa-api/beta/conversations/postsearchconversations","metadata":{"seo":{"title":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both"}},"httpPath":"/beta/search/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List rating","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidrating","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidrating","metadata":{"seo":{"title":"List rating","description":"Deprecated rating endpoint. Use '/ratings'."}},"httpPath":"/beta/conversations/{conversationId}/rating","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Search conversations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getsearchconversations","routeSlug":"/openapi/dixa-api/beta/conversations/getsearchconversations","metadata":{"seo":{"title":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."}},"httpPath":"/beta/search/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Messages","link":"/openapi/dixa-api/beta/messages","routeSlug":"/openapi/dixa-api/beta/messages","items":[{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"httpPath":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/messages/getconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/messages/getconversationsconversationidmessages","metadata":{"seo":{"title":"List messages","description":"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."}},"httpPath":"/beta/conversations/{conversationId}/messages","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Add message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/messages/postconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/messages/postconversationsconversationidmessages","metadata":{"seo":{"title":"Add message","description":"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. <br>If attachments are added to the message, they will be copied and stored in Dixa. <br> Content in outbound message is required except for Whatsapp messages. <br> Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). <br><br> Supported Markdown syntax for Markdown content: bold <code>**text**</code>, italic <code>*text*</code>, bold & italic <code>***text***</code>, strikethrough <code>~text~</code>, blockquote <code> > Quoted text. \\n Message about quoted text</code>, ordered list <code>List:\\n1. Item\\n2. Item\\n3. Item</code>, unordered list <code>List:\\n* Item\\n* Item\\n* Item</code>, inline code <code>This is `code`</code>. <br><br> Whatsapp channel: <br> Only one attachment is allowed per WhatsApp message. <br> Supports adding a message with attachment only (no content). <br> Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"}},"httpPath":"/beta/conversations/{conversationId}/messages","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Internal Notes","link":"/openapi/dixa-api/beta/internal-notes","routeSlug":"/openapi/dixa-api/beta/internal-notes","items":[{"label":"Add internal notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotesbulk","routeSlug":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotesbulk","metadata":{"seo":{"title":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/notes/bulk","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List internal notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/internal-notes/getconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/internal-notes/getconversationsconversationidnotes","metadata":{"seo":{"title":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/notes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Add internal note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotes","metadata":{"seo":{"title":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/notes","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Ratings","link":"/openapi/dixa-api/beta/ratings","routeSlug":"/openapi/dixa-api/beta/ratings","items":[{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"httpPath":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"httpPath":"/beta/conversations/{conversationId}/ratings/offer","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List ratings for a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/getconversationsconversationidratings","routeSlug":"/openapi/dixa-api/beta/ratings/getconversationsconversationidratings","metadata":{"seo":{"title":"List ratings for a conversation","description":"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."}},"httpPath":"/beta/conversations/{conversationId}/ratings","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List rating","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/getconversationsconversationidrating","routeSlug":"/openapi/dixa-api/beta/ratings/getconversationsconversationidrating","metadata":{"seo":{"title":"List rating","description":"Deprecated rating endpoint. Use '/ratings'."}},"httpPath":"/beta/conversations/{conversationId}/rating","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Tags","link":"/openapi/dixa-api/beta/tags","routeSlug":"/openapi/dixa-api/beta/tags","items":[{"label":"Tag conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/putconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/tags/putconversationsconversationidtagstagid","metadata":{"seo":{"title":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations."}},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Untag conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/deleteconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/tags/deleteconversationsconversationidtagstagid","metadata":{"seo":{"title":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation."}},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Bulk tag conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/postconversationsconversationidtagsbulk","routeSlug":"/openapi/dixa-api/beta/tags/postconversationsconversationidtagsbulk","metadata":{"seo":{"title":"Bulk tag conversation","description":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."}},"httpPath":"/beta/conversations/{conversationId}/tags/bulk","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/getconversationsconversationidtags","routeSlug":"/openapi/dixa-api/beta/tags/getconversationsconversationidtags","metadata":{"seo":{"title":"List tags","description":"Get the tags for a particular conversation by providing the conversation id."}},"httpPath":"/beta/conversations/{conversationId}/tags","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/gettags","routeSlug":"/openapi/dixa-api/beta/tags/gettags","metadata":{"seo":{"title":"List tags","description":"List all tags in an organization. Only active tags are returned by default. To include deactivated tags use ?includeDeactivated=true."}},"httpPath":"/beta/tags","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/posttags","routeSlug":"/openapi/dixa-api/beta/tags/posttags","metadata":{"seo":{"title":"Create tag","description":"Create a tag."}},"httpPath":"/beta/tags","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/gettagstagid","routeSlug":"/openapi/dixa-api/beta/tags/gettagstagid","metadata":{"seo":{"title":"Get tag","description":"Get a tag by id."}},"httpPath":"/beta/tags/{tagId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/deletetagstagid","routeSlug":"/openapi/dixa-api/beta/tags/deletetagstagid","metadata":{"seo":{"title":"Delete tag","description":"Deletes the tag and all its associations. Note that this operation is irreversible."}},"httpPath":"/beta/tags/{tagId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Deactivate tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/patchtagstagiddeactivate","routeSlug":"/openapi/dixa-api/beta/tags/patchtagstagiddeactivate","metadata":{"seo":{"title":"Deactivate tag","description":"Deactivate a tag."}},"httpPath":"/beta/tags/{tagId}/deactivate","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Activate tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/patchtagstagidactivate","routeSlug":"/openapi/dixa-api/beta/tags/patchtagstagidactivate","metadata":{"seo":{"title":"Activate tag","description":"Activate a tag."}},"httpPath":"/beta/tags/{tagId}/activate","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Queues","link":"/openapi/dixa-api/beta/queues","routeSlug":"/openapi/dixa-api/beta/queues","items":[{"label":"List queues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueues","routeSlug":"/openapi/dixa-api/beta/queues/getqueues","metadata":{"seo":{"title":"List queues","description":"List all queues in an organization."}},"httpPath":"/beta/queues","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create queue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/postqueues","routeSlug":"/openapi/dixa-api/beta/queues/postqueues","metadata":{"seo":{"title":"Create queue","description":"Create a queue."}},"httpPath":"/beta/queues","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesqueueidmembers","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesqueueidmembers","metadata":{"seo":{"title":"List agents","description":"List all agents/admins that are members of a queue by providing the queue id."}},"httpPath":"/beta/queues/{queueId}/members","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Remove agents","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/deletequeuesqueueidmembers","routeSlug":"/openapi/dixa-api/beta/queues/deletequeuesqueueidmembers","metadata":{"seo":{"title":"Remove agents","description":"Bulk remove agents/admins from the specified queue."}},"httpPath":"/beta/queues/{queueId}/members","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Assign agents","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/patchqueuesqueueidmembers","routeSlug":"/openapi/dixa-api/beta/queues/patchqueuesqueueidmembers","metadata":{"seo":{"title":"Assign agents","description":"Assign one or more agents/admins to a given queue."}},"httpPath":"/beta/queues/{queueId}/members","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get queue availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesqueueidavailability","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesqueueidavailability","metadata":{"seo":{"title":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."}},"httpPath":"/beta/queues/{queueId}/availability","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesqueueid","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesqueueid","metadata":{"seo":{"title":"Get queue","description":"Get a queue by id."}},"httpPath":"/beta/queues/{queueId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get the position of the conversation in its current queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesconversation-positioncsid","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesconversation-positioncsid","metadata":{"seo":{"title":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue."}},"httpPath":"/beta/queues/conversation-position/{csid}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Contact Endpoints","link":"/openapi/dixa-api/beta/contact-endpoints","routeSlug":"/openapi/dixa-api/beta/contact-endpoints","items":[{"label":"Get contact endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpointscontactendpointid","routeSlug":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpointscontactendpointid","metadata":{"seo":{"title":"Get contact endpoint","description":"Get contact endpoint by id (email or phone number)."}},"httpPath":"/beta/contact-endpoints/{contactEndpointId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List contact endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpoints","routeSlug":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpoints","metadata":{"seo":{"title":"List contact endpoints","description":"List all available contact endpoints in an organization."}},"httpPath":"/beta/contact-endpoints","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Search","link":"/openapi/dixa-api/beta/search","routeSlug":"/openapi/dixa-api/beta/search","items":[{"label":"Search conversations with filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/search/postsearchconversations","routeSlug":"/openapi/dixa-api/beta/search/postsearchconversations","metadata":{"seo":{"title":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both"}},"httpPath":"/beta/search/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Search conversations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/search/getsearchconversations","routeSlug":"/openapi/dixa-api/beta/search/getsearchconversations","metadata":{"seo":{"title":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."}},"httpPath":"/beta/search/conversations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Webhooks","link":"/openapi/dixa-api/beta/webhooks","routeSlug":"/openapi/dixa-api/beta/webhooks","items":[{"label":"Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Webhook Subscription","description":"Get a Webhook Subscription by ID."}},"httpPath":"/beta/webhooks/{webhookSubscriptionId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/deletewebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/beta/webhooks/deletewebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Delete Webhook Subscription","description":"Delete a Webhook Subscription."}},"httpPath":"/beta/webhooks/{webhookSubscriptionId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Patch Webhook Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/patchwebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/beta/webhooks/patchwebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Patch Webhook Subscription","description":"Patch a Webhook Subscription."}},"httpPath":"/beta/webhooks/{webhookSubscriptionId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List all Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhooks","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhooks","metadata":{"seo":{"title":"List all Webhook Subscriptions","description":"List of all Webhook Subscriptions in an organization."}},"httpPath":"/beta/webhooks","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/postwebhooks","routeSlug":"/openapi/dixa-api/beta/webhooks/postwebhooks","metadata":{"seo":{"title":"Create Webhook Subscription","description":"Create a Webhook Subscription."}},"httpPath":"/beta/webhooks","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Webhook Subscription Last Delivery Statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-status","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-status","metadata":{"seo":{"title":"Webhook Subscription Last Delivery Statuses","description":"Get the latest delivery statuses of a Webhook Subscription."}},"httpPath":"/beta/webhooks/{webhookSubscriptionId}/delivery-status","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Webhook Subscription Event Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","metadata":{"seo":{"title":"Webhook Subscription Event Logs","description":"Get the latest Webhook Subscription Event logs."}},"httpPath":"/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Templates","link":"/openapi/dixa-api/beta/templates","routeSlug":"/openapi/dixa-api/beta/templates","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/templates/gettemplates","routeSlug":"/openapi/dixa-api/beta/templates/gettemplates","metadata":{"seo":{"title":"List templates","description":"Lists all templates belonging to an organization."}},"httpPath":"/beta/templates","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/templates/deletetemplatestemplateid","routeSlug":"/openapi/dixa-api/beta/templates/deletetemplatestemplateid","metadata":{"seo":{"title":"Delete template","description":"Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible."}},"httpPath":"/beta/templates/{templateId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Business Hours","link":"/openapi/dixa-api/beta/business-hours","routeSlug":"/openapi/dixa-api/beta/business-hours","items":[{"label":"List business hours schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedules","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedules","metadata":{"seo":{"title":"List business hours schedules","description":"List business hours schedules in an organization with pagination."}},"httpPath":"/beta/business-hours/schedules","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get a business hours schedule definition.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleiddefinition","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleiddefinition","metadata":{"seo":{"title":"Get a business hours schedule definition.","description":"Get a business hours schedule definition in an organization by providing its ID."}},"httpPath":"/beta/business-hours/schedules/{scheduleId}/definition","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get the upcoming business hours schedule.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidupcoming","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidupcoming","metadata":{"seo":{"title":"Get the upcoming business hours schedule.","description":"Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions. Each entry in businessHours describes one upcoming day (see its nextDate). An entry with status: Open lists the intervals during which the business is open on that day; between and outside those intervals it is closed. An entry with status: Closed is a day explicitly configured as closed and has no intervals. Days without any configured business hours are omitted from the response entirely, so businessHours can be empty when no day in the requested window has configured hours. In short: the business is open only during the intervals of status: Open entries, and closed at all other times."}},"httpPath":"/beta/business-hours/schedules/{scheduleId}/upcoming","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Check if a business is open","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidstatus","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidstatus","metadata":{"seo":{"title":"Check if a business is open","description":"Check if a business is open either right now or at the specified timestamp. When the business is open, closesAt holds the end of the current open interval and opensAt is null. When it is closed, opensAt holds the start of the next open interval — if there is one within the next year — and closesAt is null."}},"httpPath":"/beta/business-hours/schedules/{scheduleId}/status","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Knowledge","link":"/openapi/dixa-api/beta/knowledge","routeSlug":"/openapi/dixa-api/beta/knowledge","items":[{"label":"Get collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionid","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionid","metadata":{"seo":{"title":"Get collection","description":"Get a knowledge collection by id"}},"httpPath":"/beta/knowledge/collections/{collectionId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get collection catalog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionidcatalog","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionidcatalog","metadata":{"seo":{"title":"Get collection catalog","description":"Get collection catalog, including all categories and articles"}},"httpPath":"/beta/knowledge/collections/{collectionId}/catalog","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryid","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryid","metadata":{"seo":{"title":"Get category","description":"Get a knowledge category by id"}},"httpPath":"/beta/knowledge/categories/{categoryId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get category translations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryidtranslations","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryidtranslations","metadata":{"seo":{"title":"Get category translations","description":"Get the knowledge category translations"}},"httpPath":"/beta/knowledge/categories/{categoryId}/translations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleid","metadata":{"seo":{"title":"Get article","description":"Get a knowledge article by id"}},"httpPath":"/beta/knowledge/articles/{articleId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleid","metadata":{"seo":{"title":"Delete article","description":"Delete a knowledge article"}},"httpPath":"/beta/knowledge/articles/{articleId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Update article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleid","metadata":{"seo":{"title":"Update article","description":"Update a knowledge article"}},"httpPath":"/beta/knowledge/articles/{articleId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Get article translations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleidtranslations","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleidtranslations","metadata":{"seo":{"title":"Get article translations","description":"Get a knowledge article translations"}},"httpPath":"/beta/knowledge/articles/{articleId}/translations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Update article translations","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidtranslations","routeSlug":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidtranslations","metadata":{"seo":{"title":"Update article translations","description":"Update translations for a knowledge article. Supports partial success."}},"httpPath":"/beta/knowledge/articles/{articleId}/translations","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticles","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticles","metadata":{"seo":{"title":"Create article","description":"Create a knowledge article"}},"httpPath":"/beta/knowledge/articles","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Publish translation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","metadata":{"seo":{"title":"Publish translation","description":"Publish a specific translation for search"}},"httpPath":"/beta/knowledge/articles/{articleId}/translations/{languageId}/publish","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Unpublish translation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","metadata":{"seo":{"title":"Unpublish translation","description":"Mark a specific translation as unpublished"}},"httpPath":"/beta/knowledge/articles/{articleId}/translations/{languageId}/unpublish","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Delete article translation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","routeSlug":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","metadata":{"seo":{"title":"Delete article translation","description":"Delete all versions of a knowledge article translation"}},"httpPath":"/beta/knowledge/articles/{articleId}/translations/{languageId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Publish article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidpublish","metadata":{"seo":{"title":"Publish article","description":"Publish a new version of all translations for a knowledge article"}},"httpPath":"/beta/knowledge/articles/{articleId}/publish","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Unpublish article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidunpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidunpublish","metadata":{"seo":{"title":"Unpublish article","description":"Remove all translations of a knowledge article from search"}},"httpPath":"/beta/knowledge/articles/{articleId}/unpublish","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Move article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidparentparentid","routeSlug":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidparentparentid","metadata":{"seo":{"title":"Move article","description":"Move a knowledge article to a new parent"}},"httpPath":"/beta/knowledge/articles/{articleId}/parent/{parentId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Remove article parent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidparent","routeSlug":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidparent","metadata":{"seo":{"title":"Remove article parent","description":"Remove a parent from a knowledge article"}},"httpPath":"/beta/knowledge/articles/{articleId}/parent","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecollections","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecollections","metadata":{"seo":{"title":"List collections","description":"Paginated list knowledge collections"}},"httpPath":"/beta/knowledge/collections","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Upload article attachments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesattachments","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesattachments","metadata":{"seo":{"title":"Upload article attachments","description":"Upload one or more image files to be used as attachments in knowledge articles. Supported formats: image/png, image/jpeg, image/gif, image/webp. Maximum 5 files per request, 4 MB per file, with a total request payload limit of 10 MB. Supports partial success."}},"httpPath":"/beta/knowledge/articles/attachments","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Organization","link":"/openapi/dixa-api/beta/organization","routeSlug":"/openapi/dixa-api/beta/organization","items":[{"label":"Get organization details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/organization/getorganization","routeSlug":"/openapi/dixa-api/beta/organization/getorganization","metadata":{"seo":{"title":"Get organization details","description":"Retrieves information about the organization associated with the provided API token"}},"httpPath":"/beta/organization","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"Commerce Events","link":"/openapi/dixa-api/beta/commerce-events","routeSlug":"/openapi/dixa-api/beta/commerce-events","items":[{"label":"Submit commerce event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/commerce-events/postcommerce-events","routeSlug":"/openapi/dixa-api/beta/commerce-events/postcommerce-events","metadata":{"seo":{"title":"Submit commerce event","description":"Submit a commerce event for a user (e.g. order lifecycle events for conversation routing, sales attribution, and analytics)."}},"httpPath":"/beta/commerce-events","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"group","label":"WhatsApp Templates","link":"/openapi/dixa-api/beta/whatsapp-templates","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates","items":[{"label":"Get WhatsApp template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplatestemplateid","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplatestemplateid","metadata":{"seo":{"title":"Get WhatsApp template","description":"Get a WhatsApp template by id with template's category and approval status."}},"httpPath":"/beta/whatsapp/templates/{templateId}","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"List WhatsApp templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplates","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplates","metadata":{"seo":{"title":"List WhatsApp templates","description":"List WhatsApp templates for the organization, newest first. To find out a template's approval status and category, use the get template endpoint."}},"httpPath":"/beta/whatsapp/templates","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"label":"Create WhatsApp template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/whatsapp-templates/postwhatsapptemplates","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates/postwhatsapptemplates","metadata":{"seo":{"title":"Create WhatsApp template","description":"Create a new WhatsApp template. The template body is limited to 1024 characters."}},"httpPath":"/beta/whatsapp/templates","version":"beta","isDefault":false,"versionFolderId":"0aaa8853"}],"version":"beta","isDefault":false,"versionFolderId":"0aaa8853"},{"type":"link","label":"Dixa API","link":"/openapi/dixa-api/v1","routeSlug":"/openapi/dixa-api/v1","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Analytics","link":"/openapi/dixa-api/v1/analytics","routeSlug":"/openapi/dixa-api/v1/analytics","items":[{"label":"Metrics Catalogue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/getanalyticsmetrics","routeSlug":"/openapi/dixa-api/v1/analytics/getanalyticsmetrics","metadata":{"seo":{"title":"Metrics Catalogue","description":"This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data"}},"httpPath":"/v1/analytics/metrics","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get Metric Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/postanalyticsmetrics","routeSlug":"/openapi/dixa-api/v1/analytics/postanalyticsmetrics","metadata":{"seo":{"title":"Get Metric Data","description":"Get data of a specific metric (aggregated)"}},"httpPath":"/v1/analytics/metrics","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Metric Description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/getanalyticsmetricsmetricid","routeSlug":"/openapi/dixa-api/v1/analytics/getanalyticsmetricsmetricid","metadata":{"seo":{"title":"Metric Description","description":"This endpoint lists all available properties of a metric to use for querying its data"}},"httpPath":"/v1/analytics/metrics/{metricId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Filter values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/getanalyticsfilterfilterattribute","routeSlug":"/openapi/dixa-api/v1/analytics/getanalyticsfilterfilterattribute","metadata":{"seo":{"title":"Filter values","description":"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."}},"httpPath":"/v1/analytics/filter/{filterAttribute}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Metric Records Catalogue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/getanalyticsrecords","routeSlug":"/openapi/dixa-api/v1/analytics/getanalyticsrecords","metadata":{"seo":{"title":"Metric Records Catalogue","description":"This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data"}},"httpPath":"/v1/analytics/records","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get Metric Records Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/postanalyticsrecords","routeSlug":"/openapi/dixa-api/v1/analytics/postanalyticsrecords","metadata":{"seo":{"title":"Get Metric Records Data","description":"Get data of specific metric records (unaggregated)"}},"httpPath":"/v1/analytics/records","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Metric Record Description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/analytics/getanalyticsrecordsrecordid","routeSlug":"/openapi/dixa-api/v1/analytics/getanalyticsrecordsrecordid","metadata":{"seo":{"title":"Metric Record Description","description":"This endpoint lists all available properties of a record to use for querying its data"}},"httpPath":"/v1/analytics/records/{recordId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Agents","link":"/openapi/dixa-api/v1/agents","routeSlug":"/openapi/dixa-api/v1/agents","items":[{"label":"List presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/getagentspresence","routeSlug":"/openapi/dixa-api/v1/agents/getagentspresence","metadata":{"seo":{"title":"List presence","description":"List the presence status for all agents/admins in an organization."}},"httpPath":"/v1/agents/presence","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/getagents","routeSlug":"/openapi/dixa-api/v1/agents/getagents","metadata":{"seo":{"title":"List agents","description":"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."}},"httpPath":"/v1/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Update agents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/putagents","routeSlug":"/openapi/dixa-api/v1/agents/putagents","metadata":{"seo":{"title":"Update agents","description":"Bulk update agents/admins."}},"httpPath":"/v1/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/postagents","routeSlug":"/openapi/dixa-api/v1/agents/postagents","metadata":{"seo":{"title":"Create agent","description":"Create an agent."}},"httpPath":"/v1/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch agents","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/patchagents","routeSlug":"/openapi/dixa-api/v1/agents/patchagents","metadata":{"seo":{"title":"Patch agents","description":"Bulk patch agents/admins."}},"httpPath":"/v1/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/getagentsagentidteams","routeSlug":"/openapi/dixa-api/v1/agents/getagentsagentidteams","metadata":{"seo":{"title":"List teams","description":"List the teams in which the agent/admin is a member."}},"httpPath":"/v1/agents/{agentId}/teams","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/getagentsagentidpresence","routeSlug":"/openapi/dixa-api/v1/agents/getagentsagentidpresence","metadata":{"seo":{"title":"Get presence","description":"Get the presence status for an agent/admin."}},"httpPath":"/v1/agents/{agentId}/presence","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create agents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/postagentsbulk","routeSlug":"/openapi/dixa-api/v1/agents/postagentsbulk","metadata":{"seo":{"title":"Create agents","description":"Create agents in bulk."}},"httpPath":"/v1/agents/bulk","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/getagentsagentid","routeSlug":"/openapi/dixa-api/v1/agents/getagentsagentid","metadata":{"seo":{"title":"Get agent","description":"Get an agent/admin by id."}},"httpPath":"/v1/agents/{agentId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Update agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/putagentsagentid","routeSlug":"/openapi/dixa-api/v1/agents/putagentsagentid","metadata":{"seo":{"title":"Update agent","description":"Update an agent/admin."}},"httpPath":"/v1/agents/{agentId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/deleteagentsagentid","routeSlug":"/openapi/dixa-api/v1/agents/deleteagentsagentid","metadata":{"seo":{"title":"Delete agent","description":"Downgrade an agent/admin to become an end user."}},"httpPath":"/v1/agents/{agentId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch agent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/patchagentsagentid","routeSlug":"/openapi/dixa-api/v1/agents/patchagentsagentid","metadata":{"seo":{"title":"Patch agent","description":"Patch an agent/admin."}},"httpPath":"/v1/agents/{agentId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Updates the working channel of an agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/agents/putagentsagentidpresenceworking-channel","routeSlug":"/openapi/dixa-api/v1/agents/putagentsagentidpresenceworking-channel","metadata":{"seo":{"title":"Updates the working channel of an agent","description":"Updates the working channel of an agent"}},"httpPath":"/v1/agents/{agentId}/presence/working-channel","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"End Users","link":"/openapi/dixa-api/v1/end-users","routeSlug":"/openapi/dixa-api/v1/end-users","items":[{"label":"List end users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/getendusers","routeSlug":"/openapi/dixa-api/v1/end-users/getendusers","metadata":{"seo":{"title":"List end users","description":"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.<br/> <b>Note:</b> 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"}},"httpPath":"/v1/endusers","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Update end users","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/putendusers","routeSlug":"/openapi/dixa-api/v1/end-users/putendusers","metadata":{"seo":{"title":"Update end users","description":"Bulk update end users."}},"httpPath":"/v1/endusers","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create end user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/postendusers","routeSlug":"/openapi/dixa-api/v1/end-users/postendusers","metadata":{"seo":{"title":"Create end user","description":"Create an end user."}},"httpPath":"/v1/endusers","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch end users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/patchendusers","routeSlug":"/openapi/dixa-api/v1/end-users/patchendusers","metadata":{"seo":{"title":"Patch end users","description":"Bulk patch end users."}},"httpPath":"/v1/endusers","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create end users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/postendusersbulk","routeSlug":"/openapi/dixa-api/v1/end-users/postendusersbulk","metadata":{"seo":{"title":"Create end users","description":"Create multiple end users in a single bulk action"}},"httpPath":"/v1/endusers/bulk","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/getendusersuserid","routeSlug":"/openapi/dixa-api/v1/end-users/getendusersuserid","metadata":{"seo":{"title":"Get end user","description":"Get an end user by id."}},"httpPath":"/v1/endusers/{userId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Update end user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/putendusersuserid","routeSlug":"/openapi/dixa-api/v1/end-users/putendusersuserid","metadata":{"seo":{"title":"Update end user","description":"Update an end user."}},"httpPath":"/v1/endusers/{userId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/patchendusersuserid","routeSlug":"/openapi/dixa-api/v1/end-users/patchendusersuserid","metadata":{"seo":{"title":"Patch end user","description":"Patch an end user."}},"httpPath":"/v1/endusers/{userId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Anonymize end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/patchendusersuseridanonymize","routeSlug":"/openapi/dixa-api/v1/end-users/patchendusersuseridanonymize","metadata":{"seo":{"title":"Anonymize end user","description":"Request the anonymization of an end user."}},"httpPath":"/v1/endusers/{userId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch end user custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/patchendusersuseridcustom-attributes","routeSlug":"/openapi/dixa-api/v1/end-users/patchendusersuseridcustom-attributes","metadata":{"seo":{"title":"Patch end user custom attributes","description":"Patch custom attributes of an end user"}},"httpPath":"/v1/endusers/{userId}/custom-attributes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List end user conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/end-users/getendusersuseridconversations","routeSlug":"/openapi/dixa-api/v1/end-users/getendusersuseridconversations","metadata":{"seo":{"title":"List end user conversations","description":"Lists conversations requested by an end user. <br/> 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"}},"httpPath":"/v1/endusers/{userId}/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Chatbots","link":"/openapi/dixa-api/v1/chatbots","routeSlug":"/openapi/dixa-api/v1/chatbots","items":[{"label":"Create end user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/postendusers","routeSlug":"/openapi/dixa-api/v1/chatbots/postendusers","metadata":{"seo":{"title":"Create end user","description":"Create an end user."}},"httpPath":"/v1/endusers","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/getendusersuserid","routeSlug":"/openapi/dixa-api/v1/chatbots/getendusersuserid","metadata":{"seo":{"title":"Get end user","description":"Get an end user by id."}},"httpPath":"/v1/endusers/{userId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List end user conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/getendusersuseridconversations","routeSlug":"/openapi/dixa-api/v1/chatbots/getendusersuseridconversations","metadata":{"seo":{"title":"List end user conversations","description":"Lists conversations requested by an end user. <br/> 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"}},"httpPath":"/v1/endusers/{userId}/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Close conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidclose","routeSlug":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidclose","metadata":{"seo":{"title":"Close conversation","description":"Mark a conversation as closed by providing its id."}},"httpPath":"/v1/conversations/{conversationId}/close","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Followup conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidfollowup","routeSlug":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidfollowup","metadata":{"seo":{"title":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp."}},"httpPath":"/v1/conversations/{conversationId}/followup","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Transfer conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidtransferqueue","routeSlug":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidtransferqueue","metadata":{"seo":{"title":"Transfer conversation","description":"Transfer a conversation to a target queue."}},"httpPath":"/v1/conversations/{conversationId}/transfer/queue","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/v1/chatbots/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"httpPath":"/v1/conversations/{conversationId}/ratings/{ratingId}/submit","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/v1/chatbots/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"httpPath":"/v1/conversations/{conversationId}/ratings/offer","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/postconversations","routeSlug":"/openapi/dixa-api/v1/chatbots/postconversations","metadata":{"seo":{"title":"Create conversation","description":"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."}},"httpPath":"/v1/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Import conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/postconversationsimport","routeSlug":"/openapi/dixa-api/v1/chatbots/postconversationsimport","metadata":{"seo":{"title":"Import conversation","description":"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."}},"httpPath":"/v1/conversations/import","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Claim conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidclaim","routeSlug":"/openapi/dixa-api/v1/chatbots/putconversationsconversationidclaim","metadata":{"seo":{"title":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false"}},"httpPath":"/v1/conversations/{conversationId}/claim","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get queue availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/getqueuesqueueidavailability","routeSlug":"/openapi/dixa-api/v1/chatbots/getqueuesqueueidavailability","metadata":{"seo":{"title":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."}},"httpPath":"/v1/queues/{queueId}/availability","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get the position of the conversation in its current queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/chatbots/getqueuesconversation-positioncsid","routeSlug":"/openapi/dixa-api/v1/chatbots/getqueuesconversation-positioncsid","metadata":{"seo":{"title":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue."}},"httpPath":"/v1/queues/conversation-position/{csid}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Anonymization","link":"/openapi/dixa-api/v1/anonymization","routeSlug":"/openapi/dixa-api/v1/anonymization","items":[{"label":"Anonymize end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/anonymization/patchendusersuseridanonymize","routeSlug":"/openapi/dixa-api/v1/anonymization/patchendusersuseridanonymize","metadata":{"seo":{"title":"Anonymize end user","description":"Request the anonymization of an end user."}},"httpPath":"/v1/endusers/{userId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Anonymize conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/anonymization/patchconversationsconversationidanonymize","routeSlug":"/openapi/dixa-api/v1/anonymization/patchconversationsconversationidanonymize","metadata":{"seo":{"title":"Anonymize conversation","description":"Request the anonymization of a conversation."}},"httpPath":"/v1/conversations/{conversationId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/anonymization/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/v1/anonymization/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"httpPath":"/v1/conversations/{conversationId}/messages/{messageId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get anonymization status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/anonymization/getanonymizationrequestrequestid","routeSlug":"/openapi/dixa-api/v1/anonymization/getanonymizationrequestrequestid","metadata":{"seo":{"title":"Get anonymization status","description":"Retrieve an anonymization request submitted earlier (user or conversation)."}},"httpPath":"/v1/anonymization/request/{requestId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Anonymize entity","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/anonymization/postanonymization","routeSlug":"/openapi/dixa-api/v1/anonymization/postanonymization","metadata":{"seo":{"title":"Anonymize entity","description":"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."}},"httpPath":"/v1/anonymization","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Custom Attributes","link":"/openapi/dixa-api/v1/custom-attributes","routeSlug":"/openapi/dixa-api/v1/custom-attributes","items":[{"label":"Patch end user custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/custom-attributes/patchendusersuseridcustom-attributes","routeSlug":"/openapi/dixa-api/v1/custom-attributes/patchendusersuseridcustom-attributes","metadata":{"seo":{"title":"Patch end user custom attributes","description":"Patch custom attributes of an end user"}},"httpPath":"/v1/endusers/{userId}/custom-attributes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch conversation custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/custom-attributes/patchconversationsconversationidcustom-attributes","routeSlug":"/openapi/dixa-api/v1/custom-attributes/patchconversationsconversationidcustom-attributes","metadata":{"seo":{"title":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation"}},"httpPath":"/v1/conversations/{conversationId}/custom-attributes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get custom attribute definition by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/custom-attributes/getcustom-attributescustomattributeid","routeSlug":"/openapi/dixa-api/v1/custom-attributes/getcustom-attributescustomattributeid","metadata":{"seo":{"title":"Get custom attribute definition by id","description":"Get custom attribute in an organization by id."}},"httpPath":"/v1/custom-attributes/{customAttributeId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List custom attributes definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/custom-attributes/getcustom-attributes","routeSlug":"/openapi/dixa-api/v1/custom-attributes/getcustom-attributes","metadata":{"seo":{"title":"List custom attributes definitions","description":"List all custom attributes in an organization."}},"httpPath":"/v1/custom-attributes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Teams","link":"/openapi/dixa-api/v1/teams","routeSlug":"/openapi/dixa-api/v1/teams","items":[{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/getteams","routeSlug":"/openapi/dixa-api/v1/teams/getteams","metadata":{"seo":{"title":"List teams","description":"Lists all teams in an organization."}},"httpPath":"/v1/teams","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/postteams","routeSlug":"/openapi/dixa-api/v1/teams/postteams","metadata":{"seo":{"title":"Create team","description":"Create a team."}},"httpPath":"/v1/teams","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/getteamsteamidagents","routeSlug":"/openapi/dixa-api/v1/teams/getteamsteamidagents","metadata":{"seo":{"title":"List members","description":"Lists all agents/admins in a team."}},"httpPath":"/v1/teams/{teamId}/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Remove members","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/deleteteamsteamidagents","routeSlug":"/openapi/dixa-api/v1/teams/deleteteamsteamidagents","metadata":{"seo":{"title":"Remove members","description":"Remove agents/admins from a team."}},"httpPath":"/v1/teams/{teamId}/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Add members","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/patchteamsteamidagents","routeSlug":"/openapi/dixa-api/v1/teams/patchteamsteamidagents","metadata":{"seo":{"title":"Add members","description":"Add agents/admins to a team."}},"httpPath":"/v1/teams/{teamId}/agents","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/getteamsteamidpresence","routeSlug":"/openapi/dixa-api/v1/teams/getteamsteamidpresence","metadata":{"seo":{"title":"List presence","description":"List the presence status of all agents/admins in a team."}},"httpPath":"/v1/teams/{teamId}/presence","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/getteamsteamid","routeSlug":"/openapi/dixa-api/v1/teams/getteamsteamid","metadata":{"seo":{"title":"Get team","description":"Get a team by id."}},"httpPath":"/v1/teams/{teamId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/teams/deleteteamsteamid","routeSlug":"/openapi/dixa-api/v1/teams/deleteteamsteamid","metadata":{"seo":{"title":"Delete team","description":"Delete a team."}},"httpPath":"/v1/teams/{teamId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Conversations","link":"/openapi/dixa-api/v1/conversations","routeSlug":"/openapi/dixa-api/v1/conversations","items":[{"label":"Anonymize conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/patchconversationsconversationidanonymize","routeSlug":"/openapi/dixa-api/v1/conversations/patchconversationsconversationidanonymize","metadata":{"seo":{"title":"Anonymize conversation","description":"Request the anonymization of a conversation."}},"httpPath":"/v1/conversations/{conversationId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/v1/conversations/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"httpPath":"/v1/conversations/{conversationId}/messages/{messageId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Close conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidclose","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidclose","metadata":{"seo":{"title":"Close conversation","description":"Mark a conversation as closed by providing its id."}},"httpPath":"/v1/conversations/{conversationId}/close","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Followup conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidfollowup","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidfollowup","metadata":{"seo":{"title":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp."}},"httpPath":"/v1/conversations/{conversationId}/followup","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Reopen conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidreopen","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidreopen","metadata":{"seo":{"title":"Reopen conversation","description":"Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue."}},"httpPath":"/v1/conversations/{conversationId}/reopen","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Transfer conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidtransferqueue","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidtransferqueue","metadata":{"seo":{"title":"Transfer conversation","description":"Transfer a conversation to a target queue."}},"httpPath":"/v1/conversations/{conversationId}/transfer/queue","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Add internal notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsconversationidnotesbulk","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsconversationidnotesbulk","metadata":{"seo":{"title":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/notes/bulk","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List internal notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidnotes","metadata":{"seo":{"title":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/notes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Add internal note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsconversationidnotes","metadata":{"seo":{"title":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/notes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"httpPath":"/v1/conversations/{conversationId}/ratings/{ratingId}/submit","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"httpPath":"/v1/conversations/{conversationId}/ratings/offer","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List ratings for a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidratings","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidratings","metadata":{"seo":{"title":"List ratings for a conversation","description":"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."}},"httpPath":"/v1/conversations/{conversationId}/ratings","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List organization activity log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsactivitylog","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsactivitylog","metadata":{"seo":{"title":"List organization activity log","description":"List all activity logs for an organization."}},"httpPath":"/v1/conversations/activitylog","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List flows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsflows","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsflows","metadata":{"seo":{"title":"List flows","description":"List all conversations flows in an organization."}},"httpPath":"/v1/conversations/flows","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Tag conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidtagstagid","metadata":{"seo":{"title":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations."}},"httpPath":"/v1/conversations/{conversationId}/tags/{tagId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Untag conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/deleteconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/v1/conversations/deleteconversationsconversationidtagstagid","metadata":{"seo":{"title":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation."}},"httpPath":"/v1/conversations/{conversationId}/tags/{tagId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Bulk tag conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsconversationidtagsbulk","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsconversationidtagsbulk","metadata":{"seo":{"title":"Bulk tag conversation","description":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."}},"httpPath":"/v1/conversations/{conversationId}/tags/bulk","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidtags","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidtags","metadata":{"seo":{"title":"List tags","description":"Get the tags for a particular conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/tags","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidmessages","metadata":{"seo":{"title":"List messages","description":"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."}},"httpPath":"/v1/conversations/{conversationId}/messages","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Add message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsconversationidmessages","metadata":{"seo":{"title":"Add message","description":"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. <br>If attachments are added to the message, they will be copied and stored in Dixa. <br> Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). <br><br> Supported Markdown syntax for Markdown content: bold <code>**text**</code>, italic <code>*text*</code>, bold & italic <code>***text***</code>, strikethrough <code>~text~</code>, blockquote <code> > Quoted text. \\n Message about quoted text</code>, ordered list <code>List:\\n1. Item\\n2. Item\\n3. Item</code>, unordered list <code>List:\\n* Item\\n* Item\\n* Item</code>, inline code <code>This is `code`</code>. <br><br> Whatsapp channel: <br> Only one attachment is allowed per WhatsApp message. <br> Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"}},"httpPath":"/v1/conversations/{conversationId}/messages","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversations","routeSlug":"/openapi/dixa-api/v1/conversations/postconversations","metadata":{"seo":{"title":"Create conversation","description":"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."}},"httpPath":"/v1/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Import conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postconversationsimport","routeSlug":"/openapi/dixa-api/v1/conversations/postconversationsimport","metadata":{"seo":{"title":"Import conversation","description":"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."}},"httpPath":"/v1/conversations/import","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch conversation custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/patchconversationsconversationidcustom-attributes","routeSlug":"/openapi/dixa-api/v1/conversations/patchconversationsconversationidcustom-attributes","metadata":{"seo":{"title":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation"}},"httpPath":"/v1/conversations/{conversationId}/custom-attributes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Claim conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidclaim","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidclaim","metadata":{"seo":{"title":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false"}},"httpPath":"/v1/conversations/{conversationId}/claim","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List activity log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidactivitylog","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidactivitylog","metadata":{"seo":{"title":"List activity log","description":"Get the activity log for a conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/activitylog","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationid","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationid","metadata":{"seo":{"title":"Get conversation","description":"Get a conversation by id."}},"httpPath":"/v1/conversations/{conversationId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Link a conversation to a parent conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/putconversationsconversationidlink","routeSlug":"/openapi/dixa-api/v1/conversations/putconversationsconversationidlink","metadata":{"seo":{"title":"Link a conversation to a parent conversation","description":"Links the specified conversation to a parent conversation with the specified link type."}},"httpPath":"/v1/conversations/{conversationId}/link","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List linked conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidlinked","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidlinked","metadata":{"seo":{"title":"List linked conversations","description":"Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations."}},"httpPath":"/v1/conversations/{conversationId}/linked","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Search conversations with filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/postsearchconversations","routeSlug":"/openapi/dixa-api/v1/conversations/postsearchconversations","metadata":{"seo":{"title":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both"}},"httpPath":"/v1/search/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List rating","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getconversationsconversationidrating","routeSlug":"/openapi/dixa-api/v1/conversations/getconversationsconversationidrating","metadata":{"seo":{"title":"List rating","description":"Deprecated rating endpoint. Use '/ratings'."}},"httpPath":"/v1/conversations/{conversationId}/rating","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Search conversations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/conversations/getsearchconversations","routeSlug":"/openapi/dixa-api/v1/conversations/getsearchconversations","metadata":{"seo":{"title":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."}},"httpPath":"/v1/search/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Messages","link":"/openapi/dixa-api/v1/messages","routeSlug":"/openapi/dixa-api/v1/messages","items":[{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/messages/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/v1/messages/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"httpPath":"/v1/conversations/{conversationId}/messages/{messageId}/anonymize","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/messages/getconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/v1/messages/getconversationsconversationidmessages","metadata":{"seo":{"title":"List messages","description":"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."}},"httpPath":"/v1/conversations/{conversationId}/messages","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Add message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/messages/postconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/v1/messages/postconversationsconversationidmessages","metadata":{"seo":{"title":"Add message","description":"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. <br>If attachments are added to the message, they will be copied and stored in Dixa. <br> Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). <br><br> Supported Markdown syntax for Markdown content: bold <code>**text**</code>, italic <code>*text*</code>, bold & italic <code>***text***</code>, strikethrough <code>~text~</code>, blockquote <code> > Quoted text. \\n Message about quoted text</code>, ordered list <code>List:\\n1. Item\\n2. Item\\n3. Item</code>, unordered list <code>List:\\n* Item\\n* Item\\n* Item</code>, inline code <code>This is `code`</code>. <br><br> Whatsapp channel: <br> Only one attachment is allowed per WhatsApp message. <br> Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"}},"httpPath":"/v1/conversations/{conversationId}/messages","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Internal Notes","link":"/openapi/dixa-api/v1/internal-notes","routeSlug":"/openapi/dixa-api/v1/internal-notes","items":[{"label":"Add internal notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/internal-notes/postconversationsconversationidnotesbulk","routeSlug":"/openapi/dixa-api/v1/internal-notes/postconversationsconversationidnotesbulk","metadata":{"seo":{"title":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/notes/bulk","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List internal notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/internal-notes/getconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/v1/internal-notes/getconversationsconversationidnotes","metadata":{"seo":{"title":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/notes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Add internal note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/internal-notes/postconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/v1/internal-notes/postconversationsconversationidnotes","metadata":{"seo":{"title":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/notes","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Ratings","link":"/openapi/dixa-api/v1/ratings","routeSlug":"/openapi/dixa-api/v1/ratings","items":[{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/ratings/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/v1/ratings/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"httpPath":"/v1/conversations/{conversationId}/ratings/{ratingId}/submit","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/ratings/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/v1/ratings/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"httpPath":"/v1/conversations/{conversationId}/ratings/offer","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List ratings for a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/ratings/getconversationsconversationidratings","routeSlug":"/openapi/dixa-api/v1/ratings/getconversationsconversationidratings","metadata":{"seo":{"title":"List ratings for a conversation","description":"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."}},"httpPath":"/v1/conversations/{conversationId}/ratings","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List rating","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/ratings/getconversationsconversationidrating","routeSlug":"/openapi/dixa-api/v1/ratings/getconversationsconversationidrating","metadata":{"seo":{"title":"List rating","description":"Deprecated rating endpoint. Use '/ratings'."}},"httpPath":"/v1/conversations/{conversationId}/rating","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Tags","link":"/openapi/dixa-api/v1/tags","routeSlug":"/openapi/dixa-api/v1/tags","items":[{"label":"Tag conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/putconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/v1/tags/putconversationsconversationidtagstagid","metadata":{"seo":{"title":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations."}},"httpPath":"/v1/conversations/{conversationId}/tags/{tagId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Untag conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/deleteconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/v1/tags/deleteconversationsconversationidtagstagid","metadata":{"seo":{"title":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation."}},"httpPath":"/v1/conversations/{conversationId}/tags/{tagId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Bulk tag conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/postconversationsconversationidtagsbulk","routeSlug":"/openapi/dixa-api/v1/tags/postconversationsconversationidtagsbulk","metadata":{"seo":{"title":"Bulk tag conversation","description":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."}},"httpPath":"/v1/conversations/{conversationId}/tags/bulk","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/getconversationsconversationidtags","routeSlug":"/openapi/dixa-api/v1/tags/getconversationsconversationidtags","metadata":{"seo":{"title":"List tags","description":"Get the tags for a particular conversation by providing the conversation id."}},"httpPath":"/v1/conversations/{conversationId}/tags","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/gettags","routeSlug":"/openapi/dixa-api/v1/tags/gettags","metadata":{"seo":{"title":"List tags","description":"List all tags in an organization. Only active tags are returned by default. To include deactivated tags use ?includeDeactivated=true."}},"httpPath":"/v1/tags","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/posttags","routeSlug":"/openapi/dixa-api/v1/tags/posttags","metadata":{"seo":{"title":"Create tag","description":"Create a tag."}},"httpPath":"/v1/tags","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/gettagstagid","routeSlug":"/openapi/dixa-api/v1/tags/gettagstagid","metadata":{"seo":{"title":"Get tag","description":"Get a tag by id."}},"httpPath":"/v1/tags/{tagId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/deletetagstagid","routeSlug":"/openapi/dixa-api/v1/tags/deletetagstagid","metadata":{"seo":{"title":"Delete tag","description":"Deletes the tag and all its associations. Note that this operation is irreversible."}},"httpPath":"/v1/tags/{tagId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Deactivate tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/patchtagstagiddeactivate","routeSlug":"/openapi/dixa-api/v1/tags/patchtagstagiddeactivate","metadata":{"seo":{"title":"Deactivate tag","description":"Deactivate a tag."}},"httpPath":"/v1/tags/{tagId}/deactivate","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Activate tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/tags/patchtagstagidactivate","routeSlug":"/openapi/dixa-api/v1/tags/patchtagstagidactivate","metadata":{"seo":{"title":"Activate tag","description":"Activate a tag."}},"httpPath":"/v1/tags/{tagId}/activate","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Queues","link":"/openapi/dixa-api/v1/queues","routeSlug":"/openapi/dixa-api/v1/queues","items":[{"label":"List queues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/getqueues","routeSlug":"/openapi/dixa-api/v1/queues/getqueues","metadata":{"seo":{"title":"List queues","description":"List all queues in an organization."}},"httpPath":"/v1/queues","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create queue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/postqueues","routeSlug":"/openapi/dixa-api/v1/queues/postqueues","metadata":{"seo":{"title":"Create queue","description":"Create a queue."}},"httpPath":"/v1/queues","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/getqueuesqueueidmembers","routeSlug":"/openapi/dixa-api/v1/queues/getqueuesqueueidmembers","metadata":{"seo":{"title":"List agents","description":"List all agents/admins that are members of a queue by providing the queue id."}},"httpPath":"/v1/queues/{queueId}/members","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Remove agents","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/deletequeuesqueueidmembers","routeSlug":"/openapi/dixa-api/v1/queues/deletequeuesqueueidmembers","metadata":{"seo":{"title":"Remove agents","description":"Bulk remove agents/admins from the specified queue."}},"httpPath":"/v1/queues/{queueId}/members","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Assign agents","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/patchqueuesqueueidmembers","routeSlug":"/openapi/dixa-api/v1/queues/patchqueuesqueueidmembers","metadata":{"seo":{"title":"Assign agents","description":"Assign one or more agents/admins to a given queue."}},"httpPath":"/v1/queues/{queueId}/members","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get queue availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/getqueuesqueueidavailability","routeSlug":"/openapi/dixa-api/v1/queues/getqueuesqueueidavailability","metadata":{"seo":{"title":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."}},"httpPath":"/v1/queues/{queueId}/availability","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/getqueuesqueueid","routeSlug":"/openapi/dixa-api/v1/queues/getqueuesqueueid","metadata":{"seo":{"title":"Get queue","description":"Get a queue by id."}},"httpPath":"/v1/queues/{queueId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get the position of the conversation in its current queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/queues/getqueuesconversation-positioncsid","routeSlug":"/openapi/dixa-api/v1/queues/getqueuesconversation-positioncsid","metadata":{"seo":{"title":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue."}},"httpPath":"/v1/queues/conversation-position/{csid}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Contact Endpoints","link":"/openapi/dixa-api/v1/contact-endpoints","routeSlug":"/openapi/dixa-api/v1/contact-endpoints","items":[{"label":"Get contact endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/contact-endpoints/getcontact-endpointscontactendpointid","routeSlug":"/openapi/dixa-api/v1/contact-endpoints/getcontact-endpointscontactendpointid","metadata":{"seo":{"title":"Get contact endpoint","description":"Get contact endpoint by id (email or phone number)."}},"httpPath":"/v1/contact-endpoints/{contactEndpointId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List contact endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/contact-endpoints/getcontact-endpoints","routeSlug":"/openapi/dixa-api/v1/contact-endpoints/getcontact-endpoints","metadata":{"seo":{"title":"List contact endpoints","description":"List all available contact endpoints in an organization."}},"httpPath":"/v1/contact-endpoints","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Search","link":"/openapi/dixa-api/v1/search","routeSlug":"/openapi/dixa-api/v1/search","items":[{"label":"Search conversations with filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/search/postsearchconversations","routeSlug":"/openapi/dixa-api/v1/search/postsearchconversations","metadata":{"seo":{"title":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both"}},"httpPath":"/v1/search/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Search conversations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/search/getsearchconversations","routeSlug":"/openapi/dixa-api/v1/search/getsearchconversations","metadata":{"seo":{"title":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."}},"httpPath":"/v1/search/conversations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Webhooks","link":"/openapi/dixa-api/v1/webhooks","routeSlug":"/openapi/dixa-api/v1/webhooks","items":[{"label":"Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/getwebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/v1/webhooks/getwebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Webhook Subscription","description":"Get a Webhook Subscription by ID."}},"httpPath":"/v1/webhooks/{webhookSubscriptionId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/deletewebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/v1/webhooks/deletewebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Delete Webhook Subscription","description":"Delete a Webhook Subscription."}},"httpPath":"/v1/webhooks/{webhookSubscriptionId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Patch Webhook Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/patchwebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/v1/webhooks/patchwebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Patch Webhook Subscription","description":"Patch a Webhook Subscription."}},"httpPath":"/v1/webhooks/{webhookSubscriptionId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List all Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/getwebhooks","routeSlug":"/openapi/dixa-api/v1/webhooks/getwebhooks","metadata":{"seo":{"title":"List all Webhook Subscriptions","description":"List of all Webhook Subscriptions in an organization."}},"httpPath":"/v1/webhooks","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/postwebhooks","routeSlug":"/openapi/dixa-api/v1/webhooks/postwebhooks","metadata":{"seo":{"title":"Create Webhook Subscription","description":"Create a Webhook Subscription."}},"httpPath":"/v1/webhooks","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Webhook Subscription Last Delivery Statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/getwebhookswebhooksubscriptioniddelivery-status","routeSlug":"/openapi/dixa-api/v1/webhooks/getwebhookswebhooksubscriptioniddelivery-status","metadata":{"seo":{"title":"Webhook Subscription Last Delivery Statuses","description":"Get the latest delivery statuses of a Webhook Subscription."}},"httpPath":"/v1/webhooks/{webhookSubscriptionId}/delivery-status","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Webhook Subscription Event Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","routeSlug":"/openapi/dixa-api/v1/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","metadata":{"seo":{"title":"Webhook Subscription Event Logs","description":"Get the latest Webhook Subscription Event logs."}},"httpPath":"/v1/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Templates","link":"/openapi/dixa-api/v1/templates","routeSlug":"/openapi/dixa-api/v1/templates","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/templates/gettemplates","routeSlug":"/openapi/dixa-api/v1/templates/gettemplates","metadata":{"seo":{"title":"List templates","description":"Lists all templates belonging to an organization."}},"httpPath":"/v1/templates","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/templates/deletetemplatestemplateid","routeSlug":"/openapi/dixa-api/v1/templates/deletetemplatestemplateid","metadata":{"seo":{"title":"Delete template","description":"Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible."}},"httpPath":"/v1/templates/{templateId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Business Hours","link":"/openapi/dixa-api/v1/business-hours","routeSlug":"/openapi/dixa-api/v1/business-hours","items":[{"label":"List business hours schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedules","routeSlug":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedules","metadata":{"seo":{"title":"List business hours schedules","description":"List business hours schedules in an organization with pagination."}},"httpPath":"/v1/business-hours/schedules","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get a business hours schedule definition.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedulesscheduleiddefinition","routeSlug":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedulesscheduleiddefinition","metadata":{"seo":{"title":"Get a business hours schedule definition.","description":"Get a business hours schedule definition in an organization by providing its ID."}},"httpPath":"/v1/business-hours/schedules/{scheduleId}/definition","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get the upcoming business hours schedule.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedulesscheduleidupcoming","routeSlug":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedulesscheduleidupcoming","metadata":{"seo":{"title":"Get the upcoming business hours schedule.","description":"Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions. Each entry in businessHours describes one upcoming day (see its nextDate). An entry with status: Open lists the intervals during which the business is open on that day; between and outside those intervals it is closed. An entry with status: Closed is a day explicitly configured as closed and has no intervals. Days without any configured business hours are omitted from the response entirely, so businessHours can be empty when no day in the requested window has configured hours. In short: the business is open only during the intervals of status: Open entries, and closed at all other times."}},"httpPath":"/v1/business-hours/schedules/{scheduleId}/upcoming","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Check if a business is open","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedulesscheduleidstatus","routeSlug":"/openapi/dixa-api/v1/business-hours/getbusiness-hoursschedulesscheduleidstatus","metadata":{"seo":{"title":"Check if a business is open","description":"Check if a business is open either right now or at the specified timestamp. When the business is open, closesAt holds the end of the current open interval and opensAt is null. When it is closed, opensAt holds the start of the next open interval — if there is one within the next year — and closesAt is null."}},"httpPath":"/v1/business-hours/schedules/{scheduleId}/status","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Knowledge","link":"/openapi/dixa-api/v1/knowledge","routeSlug":"/openapi/dixa-api/v1/knowledge","items":[{"label":"Get collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgecollectionscollectionid","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgecollectionscollectionid","metadata":{"seo":{"title":"Get collection","description":"Get a knowledge collection by id"}},"httpPath":"/v1/knowledge/collections/{collectionId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get collection catalog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgecollectionscollectionidcatalog","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgecollectionscollectionidcatalog","metadata":{"seo":{"title":"Get collection catalog","description":"Get collection catalog, including all categories and articles"}},"httpPath":"/v1/knowledge/collections/{collectionId}/catalog","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgecategoriescategoryid","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgecategoriescategoryid","metadata":{"seo":{"title":"Get category","description":"Get a knowledge category by id"}},"httpPath":"/v1/knowledge/categories/{categoryId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get category translations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgecategoriescategoryidtranslations","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgecategoriescategoryidtranslations","metadata":{"seo":{"title":"Get category translations","description":"Get the knowledge category translations"}},"httpPath":"/v1/knowledge/categories/{categoryId}/translations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgearticlesarticleid","metadata":{"seo":{"title":"Get article","description":"Get a knowledge article by id"}},"httpPath":"/v1/knowledge/articles/{articleId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/deleteknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/v1/knowledge/deleteknowledgearticlesarticleid","metadata":{"seo":{"title":"Delete article","description":"Delete a knowledge article"}},"httpPath":"/v1/knowledge/articles/{articleId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Update article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/patchknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/v1/knowledge/patchknowledgearticlesarticleid","metadata":{"seo":{"title":"Update article","description":"Update a knowledge article"}},"httpPath":"/v1/knowledge/articles/{articleId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Get article translations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgearticlesarticleidtranslations","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgearticlesarticleidtranslations","metadata":{"seo":{"title":"Get article translations","description":"Get a knowledge article translations"}},"httpPath":"/v1/knowledge/articles/{articleId}/translations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Update article translations","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/patchknowledgearticlesarticleidtranslations","routeSlug":"/openapi/dixa-api/v1/knowledge/patchknowledgearticlesarticleidtranslations","metadata":{"seo":{"title":"Update article translations","description":"Update translations for a knowledge article. Supports partial success."}},"httpPath":"/v1/knowledge/articles/{articleId}/translations","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Create article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/postknowledgearticles","routeSlug":"/openapi/dixa-api/v1/knowledge/postknowledgearticles","metadata":{"seo":{"title":"Create article","description":"Create a knowledge article"}},"httpPath":"/v1/knowledge/articles","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Publish translation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","routeSlug":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","metadata":{"seo":{"title":"Publish translation","description":"Publish a specific translation for search"}},"httpPath":"/v1/knowledge/articles/{articleId}/translations/{languageId}/publish","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Unpublish translation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","routeSlug":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","metadata":{"seo":{"title":"Unpublish translation","description":"Mark a specific translation as unpublished"}},"httpPath":"/v1/knowledge/articles/{articleId}/translations/{languageId}/unpublish","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Delete article translation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","routeSlug":"/openapi/dixa-api/v1/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","metadata":{"seo":{"title":"Delete article translation","description":"Delete all versions of a knowledge article translation"}},"httpPath":"/v1/knowledge/articles/{articleId}/translations/{languageId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Publish article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidpublish","routeSlug":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidpublish","metadata":{"seo":{"title":"Publish article","description":"Publish a new version of all translations for a knowledge article"}},"httpPath":"/v1/knowledge/articles/{articleId}/publish","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Unpublish article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidunpublish","routeSlug":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesarticleidunpublish","metadata":{"seo":{"title":"Unpublish article","description":"Remove all translations of a knowledge article from search"}},"httpPath":"/v1/knowledge/articles/{articleId}/unpublish","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Move article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/patchknowledgearticlesarticleidparentparentid","routeSlug":"/openapi/dixa-api/v1/knowledge/patchknowledgearticlesarticleidparentparentid","metadata":{"seo":{"title":"Move article","description":"Move a knowledge article to a new parent"}},"httpPath":"/v1/knowledge/articles/{articleId}/parent/{parentId}","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Remove article parent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/deleteknowledgearticlesarticleidparent","routeSlug":"/openapi/dixa-api/v1/knowledge/deleteknowledgearticlesarticleidparent","metadata":{"seo":{"title":"Remove article parent","description":"Remove a parent from a knowledge article"}},"httpPath":"/v1/knowledge/articles/{articleId}/parent","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"List collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/getknowledgecollections","routeSlug":"/openapi/dixa-api/v1/knowledge/getknowledgecollections","metadata":{"seo":{"title":"List collections","description":"Paginated list knowledge collections"}},"httpPath":"/v1/knowledge/collections","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"label":"Upload article attachments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesattachments","routeSlug":"/openapi/dixa-api/v1/knowledge/postknowledgearticlesattachments","metadata":{"seo":{"title":"Upload article attachments","description":"Upload one or more image files to be used as attachments in knowledge articles. Supported formats: image/png, image/jpeg, image/gif, image/webp. Maximum 5 files per request, 4 MB per file, with a total request payload limit of 10 MB. Supports partial success."}},"httpPath":"/v1/knowledge/articles/attachments","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"},{"type":"group","label":"Organization","link":"/openapi/dixa-api/v1/organization","routeSlug":"/openapi/dixa-api/v1/organization","items":[{"label":"Get organization details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/v1/organization/getorganization","routeSlug":"/openapi/dixa-api/v1/organization/getorganization","metadata":{"seo":{"title":"Get organization details","description":"Retrieves information about the organization associated with the provided API token"}},"httpPath":"/v1/organization","version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"version":"v1","isDefault":true,"versionFolderId":"0aaa8853"}],"selectFirstItemOnExpand":true,"separatorLine":true},{"type":"group","label":"Exports API","items":[{"type":"link","label":"Exports API","link":"/openapi/exports-api","routeSlug":"/openapi/exports-api"},{"label":"Returns a list of conversations.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exports-api/paths/~1v1~1conversation_export/get","routeSlug":"/openapi/exports-api/paths/~1v1~1conversation_export/get","metadata":{"seo":{"title":"Returns a list of conversations.","description":"Returns a list of conversations."}},"httpPath":"/v1/conversation_export"},{"label":"Returns a list of messages.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exports-api/paths/~1v1~1message_export/get","routeSlug":"/openapi/exports-api/paths/~1v1~1message_export/get","metadata":{"seo":{"title":"Returns a list of messages.","description":"Returns a list of messages."}},"httpPath":"/v1/message_export"}],"selectFirstItemOnExpand":true}]}