{"openapi":"3.0.3","info":{"title":"Dixa API","version":"beta"},"tags":[{"name":"Analytics"},{"name":"Intelligence","description":"Get the metrics and records behind analytics in Dixa. Find a metric or record and the filters it accepts with List metrics or List records, and look up the ids to filter on with List filter values. Then send the query to the endpoint for its category: `conversations`, `agents` or `aiagents`. A metric returns values such as a count or an average, and a record returns a page of the events behind it. Read the [Intelligence API guide](https://docs.dixa.io/docs/intelligence-api-guide) for a walkthrough."},{"name":"Agents"},{"name":"AI Agents"},{"name":"End Users"},{"name":"Chatbots"},{"name":"Anonymization"},{"name":"Custom Attributes"},{"name":"Teams"},{"name":"Conversations"},{"name":"Messages"},{"name":"Internal Notes"},{"name":"Ratings"},{"name":"Tags"},{"name":"Queues"},{"name":"Contact Endpoints"},{"name":"Search"},{"name":"Webhooks"},{"name":"Templates"},{"name":"Business Hours"},{"name":"Knowledge"},{"name":"Organization"},{"name":"Commerce Events"},{"name":"WhatsApp Templates"}],"servers":[{"url":"https://dev.dixa.io"}],"paths":{"/beta/analytics/metrics":{"get":{"tags":["Analytics"],"summary":"Metrics Catalogue","description":"This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data","operationId":"getAnalyticsMetrics","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The catalogue of metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricsOutput"},"example":{"data":[{"id":"csat","description":"(Number of satisfied customers (4 and 5)/ Number of survey responses) x 100 = % of satisfied customers","filters":[{"filterAttribute":"agent_id","description":"Used to filter by the agent_id"},{"filterAttribute":"queue_id","description":"Used to filter by the queue_id"},{"filterAttribute":"channel","description":"Used to filter by the channel"},{"filterAttribute":"initial_direction","description":"Used to filter by the initial_direction"},{"filterAttribute":"tag_id","description":"Used to filter by the tag_id"},{"filterAttribute":"contact_point","description":"Used to filter by the contact_point"}],"aggregations":[{"measure":"Percentage","description":"Calculated Percentage"}],"relatedRecordIds":["ratings"]},{"id":"closed_conversations","description":"Closed conversation data","filters":[{"filterAttribute":"queue_id","description":"Used to filter by the queue_id"},{"filterAttribute":"channel","description":"Used to filter by the channel"},{"filterAttribute":"initial_direction","description":"Used to filter by the initial_direction"},{"filterAttribute":"tag_id","description":"Used to filter by the tag_id"},{"filterAttribute":"contact_point","description":"Used to filter by the contact_point"}],"aggregations":[{"measure":"Count","description":"Conversation closed count"}],"relatedRecordIds":["closed_conversations"]}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Analytics"],"summary":"Get Metric Data","description":"Get data of a specific metric (aggregated)","operationId":"postAnalyticsMetrics","requestBody":{"description":"The available request filters and aggregations for fetching the metric data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricDataInput"},"examples":{"Example0":{"value":{"id":"closed_conversations","periodFilter":{"value":{"_type":"PreviousWeek"},"_type":"Preset"},"filters":[{"attribute":"channel","values":["email"]}],"aggregations":["Count"],"timezone":"Europe/Copenhagen"}},"Example1":{"value":{"id":"closed_conversations","csidFilter":[42,43,44],"filters":[{"attribute":"channel","values":["email"]}],"aggregations":["Count"],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"The metric data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricDataOutput"},"example":{"data":{"id":"closed_conversations","aggregates":[{"value":42,"measure":"Count","_type":"LongAggregateValue"}]}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/analytics/metrics/{metricId}":{"get":{"tags":["Analytics"],"summary":"Metric Description","description":"This endpoint lists all available properties of a metric to use for querying its data","operationId":"getAnalyticsMetricsMetricid","parameters":[{"name":"metricId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The metric properties","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricOutput"},"example":{"data":{"id":"csat","description":"(Number of satisfied customers (4 and 5)/ Number of survey responses) x 100 = % of satisfied customers","filters":[{"filterAttribute":"agent_id","description":"Used to filter by the agent_id"},{"filterAttribute":"queue_id","description":"Used to filter by the queue_id"},{"filterAttribute":"channel","description":"Used to filter by the channel"},{"filterAttribute":"initial_direction","description":"Used to filter by the initial_direction"},{"filterAttribute":"tag_id","description":"Used to filter by the tag_id"},{"filterAttribute":"contact_point","description":"Used to filter by the contact_point"}],"aggregations":[{"measure":"Percentage","description":"Calculated Percentage"}],"relatedRecordIds":["ratings"]}}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/analytics/filter/{filterAttribute}":{"get":{"tags":["Analytics"],"summary":"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.","operationId":"getAnalyticsFilterFilterattribute","parameters":[{"name":"filterAttribute","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The possible filter values to be used when fetching metrics or records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFilterValuesOutput"},"example":{"data":[{"value":"CALLBACK","label":"Callback"},{"value":"CONTACT_FORM","label":"Contact Form"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/analytics/records":{"get":{"tags":["Analytics"],"summary":"Metric Records Catalogue","description":"This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data","operationId":"getAnalyticsRecords","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The catalogue of metric records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricRecordsOutput"},"example":{"data":[{"id":"ratings","description":"Conversation Ratings","filters":[{"filterAttribute":"agent_id","description":"Used to filter by the agent_id"},{"filterAttribute":"queue_id","description":"Used to filter by the queue_id"},{"filterAttribute":"channel","description":"Used to filter by the channel"},{"filterAttribute":"initial_direction","description":"Used to filter by the initial_direction"},{"filterAttribute":"tag_id","description":"Used to filter by the tag_id"},{"filterAttribute":"contact_point","description":"Used to filter by the contact_point"}],"relatedMetricIds":["csat"],"fieldsMetadata":[{"field":"conversation_id","description":"Conversation ID","nullable":false},{"field":"agent_id","description":"The agent assigned to the conversation","nullable":true},{"field":"queue_id","description":"The queue which the conversation was part of when the conversation was offered","nullable":true}]},{"id":"closed_conversations","description":"Closed conversation data","filters":[{"filterAttribute":"queue_id","description":"Used to filter by the queue_id"},{"filterAttribute":"channel","description":"Used to filter by the channel"},{"filterAttribute":"initial_direction","description":"Used to filter by the initial_direction"},{"filterAttribute":"tag_id","description":"Used to filter by the tag_id"},{"filterAttribute":"contact_point","description":"Used to filter by the contact_point"}],"relatedMetricIds":["closed_conversations"],"fieldsMetadata":[{"field":"closed_at","description":"Timestamp of when the conversation was closed","nullable":false},{"field":"conversation_id","description":"Conversation ID","nullable":false},{"field":"agent_id","description":"The agent closing the conversation","nullable":true},{"field":"queue_id","description":"The queue which the conversation was part of when the conversation was closed","nullable":true},{"field":"closed_by","description":"User closing the conversation (Agent, Enduser or Unknown)","nullable":false}]}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Analytics"],"summary":"Get Metric Records Data","description":"Get data of specific metric records (unaggregated)","operationId":"postAnalyticsRecords","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"The available request filters for fetching the metric records data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricRecordsDataInput"},"examples":{"Example0":{"value":{"id":"closed_conversations","periodFilter":{"value":{"_type":"PreviousWeek"},"_type":"Preset"},"filters":[{"attribute":"initial_direction","values":["INBOUND"]}],"timezone":"Europe/Copenhagen"}},"Example1":{"value":{"id":"closed_conversations","csidFilter":[42,43,44],"filters":[{"attribute":"initial_direction","values":["INBOUND"]}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"The metric records data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricRecordsDataOutput"},"examples":{"No Value Metric Records Data Example":{"value":{"data":[{"primaryTimestampField":{"name":"created_at","timestamp":"2023-04-21T10:23:14.293Z"},"fields":[{"name":"csid","field":{"value":184472,"_type":"LongField"}},{"name":"initial_direction","field":{"value":"INBOUND","label":"Inbound","_type":"StringField"}},{"name":"initial_channel","field":{"value":"PSTN_PHONE","label":"Phone","_type":"StringField"}},{"name":"contact_point","field":{"value":"+4511223344","label":"+4511223344","_type":"StringField"}}]},{"primaryTimestampField":{"name":"created_at","timestamp":"2023-04-21T10:24:04.259Z"},"fields":[{"name":"csid","field":{"value":184473,"_type":"LongField"}},{"name":"initial_direction","field":{"value":"INBOUND","label":"Inbound","_type":"StringField"}},{"name":"initial_channel","field":{"value":"EMAIL","label":"Email","_type":"StringField"}},{"name":"contact_point","field":{"value":"dixa@email.com","label":"dixa@email.com","_type":"StringField"}}]}]}},"Metric Records Data Example":{"value":{"data":[{"primaryTimestampField":{"name":"created_at","timestamp":"2023-04-21T10:23:01.293Z"},"value":{"value":4,"_type":"LongField"},"fields":[{"name":"csid","field":{"value":184474,"_type":"LongField"}},{"name":"current_channel","field":{"value":"EMAIL","label":"Email","_type":"StringField"}},{"name":"queue","field":{"value":"220ffe6a-3040-4ece-ae3a-c4c6d63ff3cc","label":"Example queue","_type":"UUIDField"}}]},{"primaryTimestampField":{"name":"created_at","timestamp":"2023-04-21T10:23:04.930Z"},"value":{"value":5,"_type":"LongField"},"fields":[{"name":"csid","field":{"value":184475,"_type":"LongField"}},{"name":"current_channel","field":{"value":"CONTACT_FORM","label":"Contact form","_type":"StringField"}},{"name":"queue","field":{"value":"57582f31-4fce-4435-b489-e1c7f190a92f","label":"Example queue 2","_type":"UUIDField"}}]}]}}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/analytics/records/{recordId}":{"get":{"tags":["Analytics"],"summary":"Metric Record Description","description":"This endpoint lists all available properties of a record to use for querying its data","operationId":"getAnalyticsRecordsRecordid","parameters":[{"name":"recordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The metric record properties","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetricRecordOutput"},"example":{"data":{"id":"ratings","description":"Conversation Ratings","filters":[{"filterAttribute":"agent_id","description":"Used to filter by the agent_id"},{"filterAttribute":"queue_id","description":"Used to filter by the queue_id"},{"filterAttribute":"channel","description":"Used to filter by the channel"},{"filterAttribute":"initial_direction","description":"Used to filter by the initial_direction"},{"filterAttribute":"tag_id","description":"Used to filter by the tag_id"},{"filterAttribute":"contact_point","description":"Used to filter by the contact_point"}],"relatedMetricIds":["csat"],"fieldsMetadata":[{"field":"conversation_id","description":"Conversation ID","nullable":false},{"field":"agent_id","description":"The agent assigned to the conversation","nullable":true},{"field":"queue_id","description":"The queue which the conversation was part of when the conversation was offered","nullable":true}]}}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/metrics":{"get":{"tags":["Intelligence"],"summary":"List metrics","description":"List the metrics you can query, with the filters and aggregates of each metric and the records it is based on. Use the metric `id` with Query conversation metric, Query agent metric or Query AI agent metric.","operationId":"getIntelligenceMetrics","parameters":[{"name":"category","in":"query","description":"Only list metrics in this category. If not provided, all metrics are listed.","required":false,"schema":{"type":"string","enum":["conversations","agents","aiagents"]}},{"name":"pageKey","in":"query","description":"The key of the page to fetch. To page through the results, call the link in `meta.next` or `meta.previous` of the previous response, which already carries this key.","required":false,"schema":{"type":"string"}},{"name":"pageLimit","in":"query","description":"The number of entries per page, up to 1000. Defaults to 50, or to the page size of `pageKey` when one is given.","required":false,"schema":{"default":50,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The list of metrics","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceMetricCatalogue"},"examples":{"Every metric":{"description":"Shortened to two metrics. The real response lists all metrics","value":{"data":[{"id":"closedConversations","name":"Closed conversations","category":"conversations","description":"The number of conversations closed in the selected period","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of conversations closed in the period, including those closed by deactivated agents"}],"relatedRecordIds":["closedConversations"]},{"id":"responseTime","name":"Response time","category":"conversations","description":"The time conversations waited for a reply after an end user reached out","definition":"Measures each completed interval as the milliseconds between an end user reaching out and the conversation being replied to. On asynchronous channels (e.g. Email, Contact form) an interval starts with an end user message and ends on the ensuing agent reply; when several end user messages arrive before a reply, the first of them starts the interval. On synchronous channels it starts when the end user reaches out and ends when they are connected to an agent (Phone) or receive the first outbound reply (e.g. Dixa Messenger). A conversation can contribute any number of intervals within the period.","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of completed response-time intervals"},{"name":"min","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The lowest of the completed response-time intervals"},{"name":"max","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The highest of the completed response-time intervals"},{"name":"sum","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The total of the completed response-time intervals"},{"name":"average","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The mean of the completed response-time intervals"},{"name":"stdDev","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The standard deviation of the completed response-time intervals"}],"relatedRecordIds":["responseTime"]}]}},"Filtered by category":{"description":"`?category=agents` lists only agent metrics","value":{"data":[{"id":"agentPresenceDuration","name":"Agent presence duration","category":"agents","description":"How long agents spent working and away in the selected period","definition":"Sums each agent's presence intervals, clipped to the selected period, grouped into working time (with per-media-type availability) and away time (broken down by custom away status). Durations are raw milliseconds.","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"}],"aggregates":[{"name":"working","type":"Object","defaultIncluded":true,"description":"Total working duration in milliseconds and, under `availability`, the working duration per media type (email, chat, message, speak)"},{"name":"away","type":"Object","defaultIncluded":true,"description":"Total away duration in milliseconds and, under `byStatus`, the away duration per custom away status"}],"relatedRecordIds":["agentPresenceDuration"]}]}},"First page of two":{"description":"`?pageLimit=2` returns two entries per page. Follow `meta.next` to get the next page","value":{"data":[{"id":"closedConversations","name":"Closed conversations","category":"conversations","description":"The number of conversations closed in the selected period","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of conversations closed in the period, including those closed by deactivated agents"}],"relatedRecordIds":["closedConversations"]},{"id":"responseTime","name":"Response time","category":"conversations","description":"The time conversations waited for a reply after an end user reached out","definition":"Measures each completed interval as the milliseconds between an end user reaching out and the conversation being replied to. On asynchronous channels (e.g. Email, Contact form) an interval starts with an end user message and ends on the ensuing agent reply; when several end user messages arrive before a reply, the first of them starts the interval. On synchronous channels it starts when the end user reaches out and ends when they are connected to an agent (Phone) or receive the first outbound reply (e.g. Dixa Messenger). A conversation can contribute any number of intervals within the period.","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of completed response-time intervals"},{"name":"min","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The lowest of the completed response-time intervals"},{"name":"max","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The highest of the completed response-time intervals"},{"name":"sum","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The total of the completed response-time intervals"},{"name":"average","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The mean of the completed response-time intervals"},{"name":"stdDev","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The standard deviation of the completed response-time intervals"}],"relatedRecordIds":["responseTime"]}],"meta":{"next":"/beta/intelligence/metrics?pageKey=eyJvZmZzZXQiOjIsImxpbWl0IjoyfQ&pageLimit=2"}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/records":{"get":{"tags":["Intelligence"],"summary":"List records","description":"List the records you can query, with the fields and filters of each record and the metrics based on it. Use the record `id` with Query conversation records, Query agent records or Query AI agent records.","operationId":"getIntelligenceRecords","parameters":[{"name":"category","in":"query","description":"Only list records in this category. If not provided, all records are listed.","required":false,"schema":{"type":"string","enum":["conversations","agents","aiagents"]}},{"name":"pageKey","in":"query","description":"The key of the page to fetch. To page through the results, call the link in `meta.next` or `meta.previous` of the previous response, which already carries this key.","required":false,"schema":{"type":"string"}},{"name":"pageLimit","in":"query","description":"The number of entries per page, up to 1000. Defaults to 50, or to the page size of `pageKey` when one is given.","required":false,"schema":{"default":50,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The list of records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceRecordCatalogue"},"examples":{"Every record":{"description":"Shortened to two records. The real response lists all records","value":{"data":[{"id":"closedConversations","name":"Closed conversations","category":"conversations","description":"The conversations closed in the selected period, one row each","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"fields":[{"name":"conversationId","type":"Integer","nullable":false,"description":"The conversation id"},{"name":"closedAt","type":"Timestamp","nullable":false,"description":"When the conversation was closed"},{"name":"agent","type":"Entity","nullable":true,"description":"The agent who closed the conversation","idType":"Uuid"},{"name":"queue","type":"Entity","nullable":true,"description":"The queue the conversation was in when it was closed","idType":"Uuid"},{"name":"closedBy","type":"Entity","nullable":false,"description":"Who closed the conversation — an agent, the end user, or unknown","idType":"String"},{"name":"channel","type":"Entity","nullable":true,"description":"The channel the conversation came in on","idType":"String"},{"name":"initialDirection","type":"Entity","nullable":true,"description":"The initial direction of the conversation","idType":"String"},{"name":"contactPoint","type":"Entity","nullable":true,"description":"The contact point the conversation arrived through","idType":"String"},{"name":"tags","type":"List","nullable":true,"description":"The tags attached to the conversation","items":{"type":"Entity","idType":"Uuid"}}],"relatedMetricIds":["closedConversations"]},{"id":"agentPresenceDuration","name":"Agent presence duration","category":"agents","description":"An agent's completed presence intervals in the selected period, one row each","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"}],"fields":[{"name":"endedAt","type":"Timestamp","nullable":false,"description":"When the interval ended"},{"name":"agent","type":"Entity","nullable":false,"description":"The agent the interval belongs to","idType":"Uuid"},{"name":"startedAt","type":"Timestamp","nullable":false,"description":"When the interval started"},{"name":"working","type":"Boolean","nullable":false,"description":"Whether the agent was working (vs away) during the interval"},{"name":"availableOnEmail","type":"Boolean","nullable":false,"description":"Whether the agent was available on email"},{"name":"availableOnChat","type":"Boolean","nullable":false,"description":"Whether the agent was available on interactive chat"},{"name":"availableOnMessage","type":"Boolean","nullable":false,"description":"Whether the agent was available on messaging"},{"name":"availableOnSpeak","type":"Boolean","nullable":false,"description":"Whether the agent was available on voice"},{"name":"simultaneousRing","type":"Boolean","nullable":false,"description":"Whether simultaneous ring was enabled"},{"name":"customAwayStatus","type":"Entity","nullable":true,"description":"The custom away status, when the agent was away on one","idType":"Uuid"}],"relatedMetricIds":["agentPresenceDuration"]}]}},"Filtered by category":{"description":"`?category=agents` lists only agent records","value":{"data":[{"id":"agentPresenceDuration","name":"Agent presence duration","category":"agents","description":"An agent's completed presence intervals in the selected period, one row each","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"}],"fields":[{"name":"endedAt","type":"Timestamp","nullable":false,"description":"When the interval ended"},{"name":"agent","type":"Entity","nullable":false,"description":"The agent the interval belongs to","idType":"Uuid"},{"name":"startedAt","type":"Timestamp","nullable":false,"description":"When the interval started"},{"name":"working","type":"Boolean","nullable":false,"description":"Whether the agent was working (vs away) during the interval"},{"name":"availableOnEmail","type":"Boolean","nullable":false,"description":"Whether the agent was available on email"},{"name":"availableOnChat","type":"Boolean","nullable":false,"description":"Whether the agent was available on interactive chat"},{"name":"availableOnMessage","type":"Boolean","nullable":false,"description":"Whether the agent was available on messaging"},{"name":"availableOnSpeak","type":"Boolean","nullable":false,"description":"Whether the agent was available on voice"},{"name":"simultaneousRing","type":"Boolean","nullable":false,"description":"Whether simultaneous ring was enabled"},{"name":"customAwayStatus","type":"Entity","nullable":true,"description":"The custom away status, when the agent was away on one","idType":"Uuid"}],"relatedMetricIds":["agentPresenceDuration"]}]}},"First page of two":{"description":"`?pageLimit=2` returns two entries per page. Follow `meta.next` to get the next page","value":{"data":[{"id":"closedConversations","name":"Closed conversations","category":"conversations","description":"The conversations closed in the selected period, one row each","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"fields":[{"name":"conversationId","type":"Integer","nullable":false,"description":"The conversation id"},{"name":"closedAt","type":"Timestamp","nullable":false,"description":"When the conversation was closed"},{"name":"agent","type":"Entity","nullable":true,"description":"The agent who closed the conversation","idType":"Uuid"},{"name":"queue","type":"Entity","nullable":true,"description":"The queue the conversation was in when it was closed","idType":"Uuid"},{"name":"closedBy","type":"Entity","nullable":false,"description":"Who closed the conversation — an agent, the end user, or unknown","idType":"String"},{"name":"channel","type":"Entity","nullable":true,"description":"The channel the conversation came in on","idType":"String"},{"name":"initialDirection","type":"Entity","nullable":true,"description":"The initial direction of the conversation","idType":"String"},{"name":"contactPoint","type":"Entity","nullable":true,"description":"The contact point the conversation arrived through","idType":"String"},{"name":"tags","type":"List","nullable":true,"description":"The tags attached to the conversation","items":{"type":"Entity","idType":"Uuid"}}],"relatedMetricIds":["closedConversations"]},{"id":"agentPresenceDuration","name":"Agent presence duration","category":"agents","description":"An agent's completed presence intervals in the selected period, one row each","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"}],"fields":[{"name":"endedAt","type":"Timestamp","nullable":false,"description":"When the interval ended"},{"name":"agent","type":"Entity","nullable":false,"description":"The agent the interval belongs to","idType":"Uuid"},{"name":"startedAt","type":"Timestamp","nullable":false,"description":"When the interval started"},{"name":"working","type":"Boolean","nullable":false,"description":"Whether the agent was working (vs away) during the interval"},{"name":"availableOnEmail","type":"Boolean","nullable":false,"description":"Whether the agent was available on email"},{"name":"availableOnChat","type":"Boolean","nullable":false,"description":"Whether the agent was available on interactive chat"},{"name":"availableOnMessage","type":"Boolean","nullable":false,"description":"Whether the agent was available on messaging"},{"name":"availableOnSpeak","type":"Boolean","nullable":false,"description":"Whether the agent was available on voice"},{"name":"simultaneousRing","type":"Boolean","nullable":false,"description":"Whether simultaneous ring was enabled"},{"name":"customAwayStatus","type":"Entity","nullable":true,"description":"The custom away status, when the agent was away on one","idType":"Uuid"}],"relatedMetricIds":["agentPresenceDuration"]}],"meta":{"next":"/beta/intelligence/records?pageKey=eyJvZmZzZXQiOjIsImxpbWl0IjoyfQ&pageLimit=2"}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/metrics/{metricId}":{"get":{"tags":["Intelligence"],"summary":"Get metric","description":"Get a metric by id.","operationId":"getIntelligenceMetricsMetricid","parameters":[{"name":"metricId","in":"path","description":"The metric id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The metric","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceMetric"},"examples":{"Event count":{"description":"A metric that returns a count","value":{"data":{"id":"closedConversations","name":"Closed conversations","category":"conversations","description":"The number of conversations closed in the selected period","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of conversations closed in the period, including those closed by deactivated agents"}],"relatedRecordIds":["closedConversations"]}}},"Duration statistics":{"description":"A duration metric with six values in milliseconds, and a definition of how it is calculated","value":{"data":{"id":"responseTime","name":"Response time","category":"conversations","description":"The time conversations waited for a reply after an end user reached out","definition":"Measures each completed interval as the milliseconds between an end user reaching out and the conversation being replied to. On asynchronous channels (e.g. Email, Contact form) an interval starts with an end user message and ends on the ensuing agent reply; when several end user messages arrive before a reply, the first of them starts the interval. On synchronous channels it starts when the end user reaches out and ends when they are connected to an agent (Phone) or receive the first outbound reply (e.g. Dixa Messenger). A conversation can contribute any number of intervals within the period.","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of completed response-time intervals"},{"name":"min","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The lowest of the completed response-time intervals"},{"name":"max","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The highest of the completed response-time intervals"},{"name":"sum","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The total of the completed response-time intervals"},{"name":"average","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The mean of the completed response-time intervals"},{"name":"stdDev","type":"Number","unit":"milliseconds","defaultIncluded":true,"description":"The standard deviation of the completed response-time intervals"}],"relatedRecordIds":["responseTime"]}}},"Structured aggregates":{"description":"A metric whose values are objects. See Query agent metric for what they look like","value":{"data":{"id":"agentPresenceDuration","name":"Agent presence duration","category":"agents","description":"How long agents spent working and away in the selected period","definition":"Sums each agent's presence intervals, clipped to the selected period, grouped into working time (with per-media-type availability) and away time (broken down by custom away status). Durations are raw milliseconds.","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"}],"aggregates":[{"name":"working","type":"Object","defaultIncluded":true,"description":"Total working duration in milliseconds and, under `availability`, the working duration per media type (email, chat, message, speak)"},{"name":"away","type":"Object","defaultIncluded":true,"description":"Total away duration in milliseconds and, under `byStatus`, the away duration per custom away status"}],"relatedRecordIds":["agentPresenceDuration"]}}},"Conditional counts":{"description":"An AI agent metric that returns a total and a count per score","value":{"data":{"id":"aiAgentFeedback","name":"AI agent feedback","category":"aiagents","description":"The number of AI agent answers end users rated in the selected period, in total and per score","definition":"Counts the thumbs ratings end users gave an AI agent's answer, split into thumbs up and thumbs down.","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"},{"attribute":"conversation","aliases":["conversationId","csid"],"type":"Integer","operators":["IsOne","IsNotOne","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"],"defaultOperator":"IsOne","description":"The conversation"},{"attribute":"aiAgent","aliases":["aiAgentId"],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The AI agent"}],"aggregates":[{"name":"count","type":"Integer","defaultIncluded":true,"description":"The number of rated answers in the period"},{"name":"thumbsUp","type":"Integer","defaultIncluded":true,"description":"The number of answers rated thumbs up"},{"name":"thumbsDown","type":"Integer","defaultIncluded":true,"description":"The number of answers rated thumbs down"}],"relatedRecordIds":["aiAgentFeedback"]}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/records/{recordId}":{"get":{"tags":["Intelligence"],"summary":"Get record","description":"Get a record by id.","operationId":"getIntelligenceRecordsRecordid","parameters":[{"name":"recordId","in":"path","description":"The record id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The record","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceRecord"},"examples":{"Conversation record":{"description":"A record you can query by period or conversation ids, with seven filters and a list of tags","value":{"data":{"id":"closedConversations","name":"Closed conversations","category":"conversations","description":"The conversations closed in the selected period, one row each","deprecated":false,"primaryFilters":["period","conversationIds"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"},{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"team","aliases":["teamId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The team the conversation was assigned to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"}],"fields":[{"name":"conversationId","type":"Integer","nullable":false,"description":"The conversation id"},{"name":"closedAt","type":"Timestamp","nullable":false,"description":"When the conversation was closed"},{"name":"agent","type":"Entity","nullable":true,"description":"The agent who closed the conversation","idType":"Uuid"},{"name":"queue","type":"Entity","nullable":true,"description":"The queue the conversation was in when it was closed","idType":"Uuid"},{"name":"closedBy","type":"Entity","nullable":false,"description":"Who closed the conversation — an agent, the end user, or unknown","idType":"String"},{"name":"channel","type":"Entity","nullable":true,"description":"The channel the conversation came in on","idType":"String"},{"name":"initialDirection","type":"Entity","nullable":true,"description":"The initial direction of the conversation","idType":"String"},{"name":"contactPoint","type":"Entity","nullable":true,"description":"The contact point the conversation arrived through","idType":"String"},{"name":"tags","type":"List","nullable":true,"description":"The tags attached to the conversation","items":{"type":"Entity","idType":"Uuid"}}],"relatedMetricIds":["closedConversations"]}}},"Agent record":{"description":"A record you can only query by period, with a single filter","value":{"data":{"id":"agentPresenceDuration","name":"Agent presence duration","category":"agents","description":"An agent's completed presence intervals in the selected period, one row each","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"agent","aliases":["agentId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The agent (AI or human) assigned to the conversation"}],"fields":[{"name":"endedAt","type":"Timestamp","nullable":false,"description":"When the interval ended"},{"name":"agent","type":"Entity","nullable":false,"description":"The agent the interval belongs to","idType":"Uuid"},{"name":"startedAt","type":"Timestamp","nullable":false,"description":"When the interval started"},{"name":"working","type":"Boolean","nullable":false,"description":"Whether the agent was working (vs away) during the interval"},{"name":"availableOnEmail","type":"Boolean","nullable":false,"description":"Whether the agent was available on email"},{"name":"availableOnChat","type":"Boolean","nullable":false,"description":"Whether the agent was available on interactive chat"},{"name":"availableOnMessage","type":"Boolean","nullable":false,"description":"Whether the agent was available on messaging"},{"name":"availableOnSpeak","type":"Boolean","nullable":false,"description":"Whether the agent was available on voice"},{"name":"simultaneousRing","type":"Boolean","nullable":false,"description":"Whether simultaneous ring was enabled"},{"name":"customAwayStatus","type":"Entity","nullable":true,"description":"The custom away status, when the agent was away on one","idType":"Uuid"}],"relatedMetricIds":["agentPresenceDuration"]}}},"AI agent record":{"description":"An AI agent record you can only query by period, filtered with `aiAgent`","value":{"data":{"id":"aiAgentFeedback","name":"AI agent feedback","category":"aiagents","description":"The AI agent answers end users rated in the selected period, one row per rating","deprecated":false,"primaryFilters":["period"],"filters":[{"attribute":"queue","aliases":["queueId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The queue the conversation was routed to"},{"attribute":"tag","aliases":["tagId"],"type":"Uuid","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll"],"defaultOperator":"IsOne","description":"A tag attached to the conversation"},{"attribute":"channel","aliases":[],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The channel the conversation came in on"},{"attribute":"initialDirection","aliases":["direction"],"type":"String","operators":["IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The initial direction of the conversation"},{"attribute":"contactPoint","aliases":[],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The contact point the conversation arrived through"},{"attribute":"conversation","aliases":["conversationId","csid"],"type":"Integer","operators":["IsOne","IsNotOne","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"],"defaultOperator":"IsOne","description":"The conversation"},{"attribute":"aiAgent","aliases":["aiAgentId"],"type":"String","operators":["IsEmpty","IsNotEmpty","IsOne","IsNotOne"],"defaultOperator":"IsOne","description":"The AI agent"}],"fields":[{"name":"conversationId","type":"Integer","nullable":false,"description":"The conversation id"},{"name":"submittedAt","type":"Timestamp","nullable":false,"description":"When the feedback was submitted"},{"name":"aiAgent","type":"Entity","nullable":false,"description":"The AI agent whose answer was rated","idType":"String"},{"name":"queue","type":"Entity","nullable":true,"description":"The most recent queue the conversation was in","idType":"Uuid"},{"name":"feedbackType","type":"Entity","nullable":false,"description":"The kind of rating given","idType":"String"},{"name":"score","type":"Integer","nullable":false,"description":"The score given: 1 for thumbs up, 0 for thumbs down"},{"name":"responseId","type":"String","nullable":false,"description":"The AI agent answer that was rated"},{"name":"channel","type":"Entity","nullable":true,"description":"The channel the conversation came in on","idType":"String"},{"name":"initialDirection","type":"Entity","nullable":true,"description":"The initial direction of the conversation","idType":"String"},{"name":"contactPoint","type":"Entity","nullable":true,"description":"The contact point the conversation arrived through","idType":"String"},{"name":"tags","type":"List","nullable":true,"description":"The tags attached to the conversation","items":{"type":"Entity","idType":"Uuid"}}],"relatedMetricIds":["aiAgentFeedback"]}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/conversations/metrics/{metricId}":{"post":{"tags":["Intelligence"],"summary":"Query conversation metric","description":"Get the value of a conversation metric for a period or a list of conversations. All aggregates of the metric are returned. If nothing matches, `count` is 0 and the other aggregates are null.","operationId":"postIntelligenceConversationsMetricsMetricid","parameters":[{"name":"metricId","in":"path","description":"The id of a conversation metric","required":true,"schema":{"type":"string"},"examples":{"closedConversations · Interval · Queue and direction filters":{"value":"closedConversations"},"responseTime · Conversation ids · Duration statistics":{"value":"responseTime"},"createdConversations · Preset · No filters":{"value":"createdConversations"},"responseTime · Interval · Included channels, excluded tag":{"value":"responseTime"},"queuedDuration · Interval · Untagged conversations, nothing matched":{"value":"queuedDuration"},"abandonedConversations · Preset · Phone calls to one number":{"value":"abandonedConversations"},"csat · Interval · One team":{"value":"csat"},"fcr · Interval · One agent":{"value":"fcr"},"onHoldDuration · Interval · Assigned conversations only":{"value":"onHoldDuration"}}}],"requestBody":{"description":"The query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationMetricDataRequest"},"examples":{"closedConversations · Interval · Queue and direction filters":{"description":"Without an `operator`, the filter uses the attribute's `defaultOperator`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"queue","values":["2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"],"operator":"IsOne"},{"attribute":"initialDirection","values":["Inbound"]}],"timezone":"Europe/Copenhagen"}},"responseTime · Conversation ids · Duration statistics":{"description":"Only these conversations are included, regardless of when they happened","value":{"primaryFilter":{"conversationIds":[8123456,8123481,8123502]},"timezone":"Europe/Copenhagen"}},"createdConversations · Preset · No filters":{"description":"Presets are evaluated in the timezone of the query. `Last7Days` includes today","value":{"primaryFilter":{"period":{"preset":"Last7Days"}},"timezone":"Europe/Copenhagen"}},"responseTime · Interval · Included channels, excluded tag":{"description":"`IsOne` matches any of the values. `IsNotOne` leaves out conversations with any of the tags. All filters must match","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"channel","values":["Email","ContactForm"],"operator":"IsOne"},{"attribute":"tag","values":["d41a7e90-5b2c-4f83-a6e1-0c9d3b8f2a57"],"operator":"IsNotOne"}],"timezone":"Europe/Copenhagen"}},"queuedDuration · Interval · Untagged conversations, nothing matched":{"description":"`IsEmpty` takes an empty list of values. Here it matches conversations without tags","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"queue","values":["7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63"],"operator":"IsOne"},{"attribute":"tag","values":[],"operator":"IsEmpty"}],"timezone":"Europe/Copenhagen"}},"abandonedConversations · Preset · Phone calls to one number":{"description":"`contactPoint` is the email address or phone number the conversation came in through. Channel ids come from List filter values","value":{"primaryFilter":{"period":{"preset":"Today"}},"filters":[{"attribute":"channel","values":["PstnPhone"],"operator":"IsOne"},{"attribute":"contactPoint","values":["+18889100777"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"csat · Interval · One team":{"description":"Both `from` and `to` are inclusive, so the month ends at its last millisecond","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-06-30T23:59:59.999Z"}}},"filters":[{"attribute":"team","values":["9d2f7b31-4c68-4e13-b590-8a3f1d7c6e29"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"fcr · Interval · One agent":{"description":"First contact resolution cannot be filtered by team. `from` must be before `to`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-04-01T00:00:00Z","to":"2026-06-30T23:59:59.999Z"}}},"filters":[{"attribute":"agent","values":["a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"onHoldDuration · Interval · Assigned conversations only":{"description":"`IsNotEmpty` takes an empty list of values. Here it matches conversations with an agent","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"agent","values":[],"operator":"IsNotEmpty"}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"The metric values, keyed by aggregate name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceMetricValues"},"examples":{"closedConversations · Interval · Queue and direction filters":{"description":"The number of closed conversations","value":{"data":{"count":1284}}},"responseTime · Conversation ids · Duration statistics":{"description":"A count and five durations in milliseconds","value":{"data":{"count":1284,"min":12000,"max":864321000,"average":35725965.732087225,"stdDev":61238905.11740288,"sum":45872140000}}},"createdConversations · Preset · No filters":{"description":"All conversations created in the period","value":{"data":{"count":412}}},"responseTime · Interval · Included channels, excluded tag":{"description":"The same six values, for the matching conversations only","value":{"data":{"count":936,"min":9000,"max":518400000,"average":30058461.53846154,"stdDev":47120655.88430212,"sum":28134720000}}},"queuedDuration · Interval · Untagged conversations, nothing matched":{"description":"When nothing matches, `count` is 0 and `min`, `max`, `sum`, `average` and `stdDev` are `null`. Some documentation viewers do not show null values","value":{"data":{"count":0}}},"abandonedConversations · Preset · Phone calls to one number":{"description":"The number of conversations abandoned in a queue before an agent was assigned","value":{"data":{"count":17}}},"csat · Interval · One team":{"description":"`percentage` is the share of satisfied ratings, those with a score of 4 or 5, from 0 to 100, `count` is the number of ratings and `average` is the mean rating, from 1 to 5. `percentage` and `average` are null when there are no ratings","value":{"data":{"percentage":87.23404255319149,"count":235,"average":4.391489361702128}}},"fcr · Interval · One agent":{"description":"A `percentage` from 0 to 100","value":{"data":{"percentage":71.42857142857143}}},"onHoldDuration · Interval · Assigned conversations only":{"description":"How long calls were on hold, in milliseconds","value":{"data":{"count":58,"min":4000,"max":612000,"average":72586.20689655172,"stdDev":98714.3310291778,"sum":4210000}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/agents/metrics/{metricId}":{"post":{"tags":["Intelligence"],"summary":"Query agent metric","description":"Get the value of an agent metric for a period. All aggregates of the metric are returned. If nothing matches, `count` is 0 and the other aggregates are null, except presence durations, which are 0. Deactivated agents are included.","operationId":"postIntelligenceAgentsMetricsMetricid","parameters":[{"name":"metricId","in":"path","description":"The id of an agent metric","required":true,"schema":{"type":"string"},"examples":{"agentPresenceDuration · Interval · Whole organization":{"value":"agentPresenceDuration"},"agentPresenceDuration · Preset · One agent, no presence":{"value":"agentPresenceDuration"},"agentAssignmentReasons · Interval · One queue and team, with a breakdown":{"value":"agentAssignmentReasons"},"agentOffersTimedOut · Interval · One agent, phone only":{"value":"agentOffersTimedOut"},"agentClaims · Interval · Conversations from an id onward":{"value":"agentClaims"}}}],"requestBody":{"description":"The query","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AgentMetricDataRequest"}]},"examples":{"agentPresenceDuration · Interval · Whole organization":{"description":"The presence of all agents in the period, added up","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"timezone":"Europe/Copenhagen"}},"agentPresenceDuration · Preset · One agent, no presence":{"description":"One agent. `agent` is the only filter presence supports","value":{"primaryFilter":{"period":{"preset":"PreviousWeek"}},"filters":[{"attribute":"agent","values":["a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"agentAssignmentReasons · Interval · One queue and team, with a breakdown":{"description":"Other agent metrics support the conversation filters, such as `queue` and `team`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"queue","values":["2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"],"operator":"IsOne"},{"attribute":"team","values":["9d2f7b31-4c68-4e13-b590-8a3f1d7c6e29"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"agentOffersTimedOut · Interval · One agent, phone only":{"description":"Queue offers the agent did not accept in time, for one agent and channel","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"agent","values":["c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"],"operator":"IsOne"},{"attribute":"channel","values":["PstnPhone"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"agentClaims · Interval · Conversations from an id onward":{"description":"`conversation` takes conversation ids and supports comparison operators. Only agent metrics and records support it","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"conversation","values":["8123000"],"operator":"GreaterThanOrEqual"}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"The metric values, keyed by aggregate name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceMetricValues"},"examples":{"agentPresenceDuration · Interval · Whole organization":{"description":"Time working, per channel the agent was available on, and time away, per away status","value":{"data":{"working":{"durationMs":18420000,"availability":{"email":18420000,"chat":18420000,"message":12300000,"speak":0}},"away":{"durationMs":5400000,"byStatus":[{"customAwayStatus":{"id":"3c6f2a18-8d47-4b93-a05e-2f7c9b1d6a38","label":"Lunch"},"durationMs":1800000},{"durationMs":3600000}]}}}},"agentPresenceDuration · Preset · One agent, no presence":{"description":"When the agent was not present, all durations are 0","value":{"data":{"working":{"durationMs":0,"availability":{"email":0,"chat":0,"message":0,"speak":0}},"away":{"durationMs":0,"byStatus":[]}}}},"agentAssignmentReasons · Interval · One queue and team, with a breakdown":{"description":"The total, and the number per reason. The five reasons add up to `count`","value":{"data":{"transferOffers":9,"claims":17,"count":120,"queueOffers":84,"bulkActions":4,"outboundConversations":6}}},"agentOffersTimedOut · Interval · One agent, phone only":{"description":"The number of offers","value":{"data":{"count":23}}},"agentClaims · Interval · Conversations from an id onward":{"description":"The number of claimed conversations","value":{"data":{"count":31}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/aiagents/metrics/{metricId}":{"post":{"tags":["Intelligence"],"summary":"Query AI agent metric","description":"Get the value of an AI agent metric for a period. All aggregates of the metric are returned. If nothing matches, the counts are 0. Deleted AI agents are included.","operationId":"postIntelligenceAiagentsMetricsMetricid","parameters":[{"name":"metricId","in":"path","description":"The id of an AI agent metric","required":true,"schema":{"type":"string"},"examples":{"aiAgentFeedback · Interval · All AI agents":{"value":"aiAgentFeedback"},"aiAgentJoined · Preset · One AI agent":{"value":"aiAgentJoined"},"aiAgentToolCalls · Interval · Chat only":{"value":"aiAgentToolCalls"}}}],"requestBody":{"description":"The query","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AiAgentMetricDataRequest"}]},"examples":{"aiAgentFeedback · Interval · All AI agents":{"description":"The ratings end users gave the answers of all AI agents in the period","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"timezone":"Europe/Copenhagen"}},"aiAgentJoined · Preset · One AI agent":{"description":"`aiAgent` takes the AI agent ids from List filter values","value":{"primaryFilter":{"period":{"preset":"PreviousWeek"}},"filters":[{"attribute":"aiAgent","values":["0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"aiAgentToolCalls · Interval · Chat only":{"description":"AI agent metrics support the conversation filters, except `agent` and `team`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"channel","values":["Messenger"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"The metric values, keyed by aggregate name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceMetricValues"},"examples":{"aiAgentFeedback · Interval · All AI agents":{"description":"The number of rated answers, and how many were rated thumbs up and thumbs down","value":{"data":{"count":412,"thumbsUp":351,"thumbsDown":61}}},"aiAgentJoined · Preset · One AI agent":{"description":"The number of times the AI agent joined a conversation","value":{"data":{"count":268}}},"aiAgentToolCalls · Interval · Chat only":{"description":"The number of tool calls","value":{"data":{"count":1043}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/conversations/records/{recordId}":{"post":{"tags":["Intelligence"],"summary":"Query conversation records","description":"Get the rows of a conversation record for a period or a list of conversations. To get the next page, send the same query with `meta.next` as `pagination.pageKey`. Columns without a value are left out of the row.","operationId":"postIntelligenceConversationsRecordsRecordid","parameters":[{"name":"recordId","in":"path","description":"The id of a conversation record","required":true,"schema":{"type":"string"},"examples":{"closedConversations · Interval · Two channels, both tags":{"value":"closedConversations"},"responseTime · Conversation ids · No labels":{"value":"responseTime"},"interactions · Preset · Final page":{"value":"interactions"},"conversationRatingUpdated · Interval · Ratings for one queue, small pages":{"value":"conversationRatingUpdated"},"taggedConversations · Interval · Two tags, inbound only":{"value":"taggedConversations"},"conversationsTransferredToQueue · Interval · Phone transfers by two agents":{"value":"conversationsTransferredToQueue"},"conversationCustomAttributesUpdated · Interval · Contact form, spam excluded, no labels":{"value":"conversationCustomAttributesUpdated"},"slaEvaluationUpdated · Interval · One SLA policy in one queue":{"value":"slaEvaluationUpdated"},"conversationMessages · Interval · Largest page, internal excluded, no labels":{"value":"conversationMessages"},"conversationState · Interval · Two queues":{"value":"conversationState"}}}],"requestBody":{"description":"The query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationRecordDataRequest"},"examples":{"closedConversations · Interval · Two channels, both tags":{"description":"Two channels. `IsAll` matches conversations that have all of the tags","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"channel","values":["Email","ContactForm"],"operator":"IsOne"},{"attribute":"tag","values":["5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72"],"operator":"IsAll"}],"timezone":"Europe/Copenhagen","pagination":{"pageLimit":50},"includeLabels":true}},"responseTime · Conversation ids · No labels":{"description":"Only these conversations are included. `includeLabels: false` leaves out the display names","value":{"primaryFilter":{"conversationIds":[8123456,8123481,8123502]},"timezone":"Europe/Copenhagen","includeLabels":false}},"interactions · Preset · Final page":{"description":"A `pageKey` from `meta.next` of the previous response","value":{"primaryFilter":{"period":{"preset":"PreviousWeek"}},"filters":[{"attribute":"agent","values":["a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04"]}],"timezone":"Europe/Copenhagen","pagination":{"pageKey":"eyJ0aW1lc3RhbXAiOiIyMDI2LTA2LTIzVDA4OjQxOjU1LjYwMFoiLCJzZWNvbmRhcnlLZXkiOiI4MTIzNDcwIiwibGltaXQiOjUwLCJkaXJlY3Rpb24iOiJuZXh0In0","pageLimit":50}}},"conversationRatingUpdated · Interval · Ratings for one queue, small pages":{"description":"`pageLimit` sets the page size, from 1 to 200","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"queue","values":["2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen","pagination":{"pageLimit":2}}},"taggedConversations · Interval · Two tags, inbound only":{"description":"One row per tag added. The `tag` filter matches the tag that was added","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"tag","values":["5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72"],"operator":"IsOne"},{"attribute":"initialDirection","values":["Inbound"]}],"timezone":"Europe/Copenhagen"}},"conversationsTransferredToQueue · Interval · Phone transfers by two agents":{"description":"`IsOne` matches any of the values","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"channel","values":["PstnPhone"],"operator":"IsOne"},{"attribute":"agent","values":["a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"conversationCustomAttributesUpdated · Interval · Contact form, spam excluded, no labels":{"description":"This record cannot be filtered by queue. `IsNotOne` leaves out conversations with the tag","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"channel","values":["ContactForm"],"operator":"IsOne"},{"attribute":"tag","values":["d41a7e90-5b2c-4f83-a6e1-0c9d3b8f2a57"],"operator":"IsNotOne"}],"timezone":"Europe/Copenhagen","includeLabels":false}},"slaEvaluationUpdated · Interval · One SLA policy in one queue":{"description":"Only this record supports `slaPolicy`, and its ids are numbers. The period applies to `updatedAt`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"slaPolicy","values":["412"],"operator":"IsOne"},{"attribute":"queue","values":["2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen","includeLabels":true}},"conversationMessages · Interval · Largest page, internal excluded, no labels":{"description":"200 is the largest `pageLimit`. `IsNotOne` leaves out internal conversations","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"initialDirection","values":["Internal"],"operator":"IsNotOne"}],"timezone":"Europe/Copenhagen","pagination":{"pageLimit":200},"includeLabels":false}},"conversationState · Interval · Two queues":{"description":"One row per conversation, with its current state","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"queue","values":["2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"One page of rows, and the keys of the previous and next pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceRecordPage"},"examples":{"closedConversations · Interval · Two channels, both tags":{"description":"One row per closed conversation. Columns without a value, or a reference to something deleted such as a queue, are left out","value":{"data":[{"channel":{"id":"Email","label":"Email"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"},{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72","label":"refund"}],"closedBy":{"id":"Agent","label":"Agent"},"closedAt":"2026-06-18T09:14:04.773+00:00","agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"conversationId":8123456,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"ContactForm","label":"Contact Form"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"},{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72","label":"refund"}],"closedBy":{"id":"EndUser","label":"End User"},"closedAt":"2026-06-18T11:03:27.48+00:00","contactPoint":{"id":"+18889100777"},"conversationId":8123481,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}},"responseTime · Conversation ids · No labels":{"description":"References contain only an `id`. Timestamps have up to three decimals","value":{"data":[{"channel":{"id":"Email"},"endedAt":"2026-06-18T09:15:32.483+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04"},{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72"}],"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04"},"contactPoint":{"id":"support@example.com"},"isFirstResponse":true,"conversationId":8123456,"initialDirection":{"id":"Inbound"},"createdAt":"2026-06-18T09:14:04.773+00:00","startedAt":"2026-06-18T09:14:04.773+00:00"},{"channel":{"id":"PstnPhone"},"endedAt":"2026-06-19T13:07:41.17+00:00","queue":{"id":"7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63"},"isFirstResponse":false,"conversationId":8123481,"initialDirection":{"id":"Inbound"},"createdAt":"2026-06-19T12:58:03+00:00","startedAt":"2026-06-19T13:02:18.9+00:00"}],"meta":{"pageLimit":50}}},"interactions · Preset · Final page":{"description":"The last page has a `previous` key and no `next` key","value":{"data":[{"channel":{"id":"Email","label":"Email"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"}],"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"createdAt":"2026-06-24T14:19:44.62+00:00","conversationId":8123502,"initialDirection":{"id":"Inbound","label":"Inbound"},"respondedAt":"2026-06-24T14:22:09.117+00:00","isFirstResponse":true}],"meta":{"previous":"eyJ0aW1lc3RhbXAiOiIyMDI2LTA2LTI0VDE0OjIyOjA5LjExN1oiLCJzZWNvbmRhcnlLZXkiOiI4MTIzNTAyIiwibGltaXQiOjUwLCJkaXJlY3Rpb24iOiJwcmV2aW91cyJ9","pageLimit":50}}},"conversationRatingUpdated · Interval · Ratings for one queue, small pages":{"description":"A full page has a `next` key. A rating without a comment or an agent has no such columns","value":{"data":[{"channel":{"id":"Email","label":"Email"},"submittedAt":"2026-06-18T09:42:10.281+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"}],"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"comment":"Quick and friendly, thanks!","ratingId":"b9f4e2c0-5a17-4d83-8e26-3c1a7f9d0b45","ratingType":{"id":"Csat","label":"Csat"},"score":5,"conversationId":8123456,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"ContactForm","label":"Contact Form"},"submittedAt":"2026-06-18T11:20:03+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"contactPoint":{"id":"+18889100777"},"ratingId":"0d5a8c71-e3b2-4f96-a148-7b2c9e6f1d30","ratingType":{"id":"Csat","label":"Csat"},"score":2,"conversationId":8123481,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"next":"eyJ0aW1lc3RhbXAiOiIyMDI2LTA2LTE4VDExOjIwOjAzWiIsInNlY29uZGFyeUtleSI6IjgxMjM0ODEiLCJhZGRpdGlvbmFsS2V5cyI6WyIxIl0sImxpbWl0IjoyLCJkaXJlY3Rpb24iOiJuZXh0In0","pageLimit":2}}},"taggedConversations · Interval · Two tags, inbound only":{"description":"This record has a single `tag`, where other records have a `tags` list","value":{"data":[{"channel":{"id":"Email","label":"Email"},"tag":{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"},"taggedAt":"2026-06-18T09:20:41.5+00:00","agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"conversationId":8123456,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"Email","label":"Email"},"tag":{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72","label":"refund"},"taggedAt":"2026-06-18T09:20:41.5+00:00","agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"conversationId":8123456,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}},"conversationsTransferredToQueue · Interval · Phone transfers by two agents":{"description":"`transferOutcomeType` shows whether the transfer was accepted","value":{"data":[{"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"transferredAt":"2026-06-12T13:48:07.332+00:00","transferType":{"id":"Assisted","label":"Assisted"},"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"+18889100777"},"transferOutcomeType":{"id":"Accepted","label":"Accepted"},"toQueue":{"id":"7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63","label":"Billing"},"channel":{"id":"PstnPhone","label":"Phone"},"conversationId":8123502,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"transferredAt":"2026-06-15T08:02:55+00:00","transferType":{"id":"Blind","label":"Blind"},"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415","label":"Amara Okafor"},"contactPoint":{"id":"+18889100777"},"transferOutcomeType":{"id":"Timeout","label":"Timeout"},"toQueue":{"id":"7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63","label":"Billing"},"channel":{"id":"PstnPhone","label":"Phone"},"conversationId":8123520,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}},"conversationCustomAttributesUpdated · Interval · Contact form, spam excluded, no labels":{"description":"`customAttributes` holds all values after the update, keyed by custom attribute id. An empty object means the last value was removed. There is no `agent` when an end user made the change","value":{"data":[{"contactPoint":{"id":"+18889100777"},"customAttributes":{"6c1e0a95-3d27-4b48-9f61-a2e8b5c74d10":"Gold","9a42f7d3-8b15-4c06-a3e9-5d1b6f208c47":3},"updatedAt":"2026-06-23T12:58:03+00:00","channel":{"id":"ContactForm"},"conversationId":8123481,"initialDirection":{"id":"Inbound"}},{"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"},"contactPoint":{"id":"+18889100777"},"customAttributes":{},"updatedAt":"2026-06-23T13:11:40.72+00:00","channel":{"id":"ContactForm"},"conversationId":8123481,"initialDirection":{"id":"Inbound"}}],"meta":{"pageLimit":50}}},"slaEvaluationUpdated · Interval · One SLA policy in one queue":{"description":"Each row is the latest state of one SLA policy, metric and response","value":{"data":[{"breachDueAt":"2026-06-24T15:19:44.62+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"}],"metric":"responseTime","conversationId":8123502,"evaluationStatus":{"id":"Breached","label":"Breached"},"sla":{"id":"412","label":"First reply within 1 hour"},"updatedAt":"2026-06-24T15:20:12.44+00:00","channel":{"id":"Email","label":"Email"},"createdAt":"2026-06-24T14:19:44.62+00:00","startedAt":"2026-06-24T14:19:44.62+00:00"},{"breachDueAt":"2026-06-25T10:02:11.9+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"metric":"responseTime","conversationId":8123560,"evaluationStatus":{"id":"Complied","label":"Achieved"},"sla":{"id":"412","label":"First reply within 1 hour"},"updatedAt":"2026-06-25T09:31:50+00:00","channel":{"id":"ContactForm","label":"Contact Form"},"createdAt":"2026-06-25T09:02:11.9+00:00","startedAt":"2026-06-25T09:02:11.9+00:00"}],"meta":{"pageLimit":50}}},"conversationMessages · Interval · Largest page, internal excluded, no labels":{"description":"An automatic message has no agent","value":{"data":[{"channel":{"id":"Email"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04"}],"direction":{"id":"Outbound"},"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04"},"contactPoint":{"id":"support@example.com"},"messageType":{"id":"Manual"},"messageCreatedAt":"2026-06-23T09:14:04.773+00:00","conversationId":8123456,"initialDirection":{"id":"Inbound"}},{"channel":{"id":"ContactForm"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"},"direction":{"id":"Outbound"},"contactPoint":{"id":"+18889100777"},"messageType":{"id":"Auto"},"messageCreatedAt":"2026-06-23T14:19:45+00:00","conversationId":8123502,"initialDirection":{"id":"Inbound"}}],"meta":{"pageLimit":200}}},"conversationState · Interval · Two queues":{"description":"An open conversation has no `outcome` or `agent` yet","value":{"data":[{"channel":{"id":"Email","label":"Email"},"statusUpdatedAt":"2026-06-22T09:15:32.483+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"}],"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"createdAt":"2026-06-22T09:14:04.773+00:00","assignedAt":"2026-06-22T09:14:20+00:00","outcome":{"id":"Answered","label":"Answered"},"status":{"id":"Closed","label":"Closed"},"queuedAt":"2026-06-22T09:14:05.1+00:00","conversationId":8123456,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"PstnPhone","label":"Phone"},"statusUpdatedAt":"2026-06-23T16:41:09+00:00","queue":{"id":"7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63","label":"Billing"},"contactPoint":{"id":"+18889100777"},"createdAt":"2026-06-23T16:41:09+00:00","status":{"id":"Open","label":"Open"},"queuedAt":"2026-06-23T16:41:10.2+00:00","conversationId":8123578,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/agents/records/{recordId}":{"post":{"tags":["Intelligence"],"summary":"Query agent records","description":"Get the rows of an agent record for a period. To get the next page, send the same query with `meta.next` as `pagination.pageKey`. Without filters, all agents are included, also deactivated ones.","operationId":"postIntelligenceAgentsRecordsRecordid","parameters":[{"name":"recordId","in":"path","description":"The id of an agent record","required":true,"schema":{"type":"string"},"examples":{"agentPresenceDuration · Interval · Two agents":{"value":"agentPresenceDuration"},"agentPresenceDuration · Preset · Every agent, no labels":{"value":"agentPresenceDuration"},"agentPresenceDuration · Interval · A deactivated agent, nothing in the period":{"value":"agentPresenceDuration"},"agentOffers · Interval · Two agents, conversations up to an id":{"value":"agentOffers"},"agentAssignmentReasons · Interval · One agent in one queue":{"value":"agentAssignmentReasons"}}}],"requestBody":{"description":"The query","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AgentRecordDataRequest"}]},"examples":{"agentPresenceDuration · Interval · Two agents":{"description":"`agent` is the only filter presence supports","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"agent","values":["a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen","pagination":{"pageLimit":50},"includeLabels":true}},"agentPresenceDuration · Preset · Every agent, no labels":{"description":"Without filters, all agents are included, also deactivated ones. `includeLabels: false` leaves out the display names","value":{"primaryFilter":{"period":{"preset":"PreviousWeek"}},"timezone":"Europe/Copenhagen","includeLabels":false}},"agentPresenceDuration · Interval · A deactivated agent, nothing in the period":{"description":"An agent who was not present in the period","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"agent","values":["e6b2a704-3f19-4d82-9c5b-4a8e1f2d7c36"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}},"agentOffers · Interval · Two agents, conversations up to an id":{"description":"`conversation` supports comparison operators. Here `LessThanOrEqual` matches conversations up to that id","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"agent","values":["a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"],"operator":"IsOne"},{"attribute":"conversation","values":["8123500"],"operator":"LessThanOrEqual"}],"timezone":"Europe/Copenhagen","pagination":{"pageLimit":2}}},"agentAssignmentReasons · Interval · One agent in one queue":{"description":"Other agent records support the conversation filters, such as `queue`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"agent","values":["c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"],"operator":"IsOne"},{"attribute":"queue","values":["2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"One page of rows, and the keys of the previous and next pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceRecordPage"},"examples":{"agentPresenceDuration · Interval · Two agents":{"description":"A working interval and an away interval. Only the away interval has a `customAwayStatus`","value":{"data":[{"working":true,"availableOnSpeak":false,"endedAt":"2026-06-18T12:30:00+00:00","availableOnMessage":true,"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"simultaneousRing":false,"availableOnChat":true,"availableOnEmail":true,"startedAt":"2026-06-18T08:00:00+00:00"},{"working":false,"availableOnSpeak":false,"availableOnMessage":false,"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"simultaneousRing":false,"availableOnChat":false,"customAwayStatus":{"id":"3c6f2a18-8d47-4b93-a05e-2f7c9b1d6a38","label":"Lunch"},"endedAt":"2026-06-18T13:00:00+00:00","availableOnEmail":false,"startedAt":"2026-06-18T12:30:00+00:00"}],"meta":{"pageLimit":50}}},"agentPresenceDuration · Preset · Every agent, no labels":{"description":"References contain only an `id`","value":{"data":[{"working":true,"availableOnSpeak":false,"endedAt":"2026-06-16T16:00:00+00:00","availableOnMessage":true,"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"},"simultaneousRing":false,"availableOnChat":false,"availableOnEmail":true,"startedAt":"2026-06-16T08:30:00+00:00"},{"working":false,"availableOnSpeak":false,"availableOnMessage":false,"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415"},"simultaneousRing":false,"availableOnChat":false,"customAwayStatus":{"id":"3c6f2a18-8d47-4b93-a05e-2f7c9b1d6a38"},"endedAt":"2026-06-16T16:45:00+00:00","availableOnEmail":false,"startedAt":"2026-06-16T16:00:00+00:00"}],"meta":{"pageLimit":50}}},"agentPresenceDuration · Interval · A deactivated agent, nothing in the period":{"description":"An empty page","value":{"data":[],"meta":{"pageLimit":50}}},"agentOffers · Interval · Two agents, conversations up to an id":{"description":"One row per offer to an agent. A full page has a `next` key","value":{"data":[{"channel":{"id":"Email","label":"Email"},"offeredAt":"2026-06-18T09:14:05.2+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tags":[{"id":"5e7a9c13-2f84-4b60-9d31-6c8a5e2f7b04","label":"vip"}],"isPreferredAgent":false,"offerType":{"id":"Standard","label":"Standard"},"agent":{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs"},"contactPoint":{"id":"support@example.com"},"isPersonalOffer":false,"conversationId":8123456,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"PstnPhone","label":"Phone"},"offeredAt":"2026-06-18T12:05:44.9+00:00","queue":{"id":"7ac3e8f4-1b92-4d05-8637-9f2c4a8e1b63","label":"Billing"},"isPreferredAgent":true,"offerType":{"id":"PreferredAgent","label":"Preferred Agent"},"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415","label":"Amara Okafor"},"contactPoint":{"id":"+18889100777"},"isPersonalOffer":true,"conversationId":8123490,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"next":"eyJ0aW1lc3RhbXAiOiIyMDI2LTA2LTE4VDEyOjA1OjQ0LjkwMFoiLCJzZWNvbmRhcnlLZXkiOiI4MTIzNDkwIiwiYWRkaXRpb25hbEtleXMiOlsiNDUwMiJdLCJsaW1pdCI6MiwiZGlyZWN0aW9uIjoibmV4dCJ9","pageLimit":2}}},"agentAssignmentReasons · Interval · One agent in one queue":{"description":"`reason` shows why the conversation was assigned, here an accepted queue offer and a claim","value":{"data":[{"channel":{"id":"PstnPhone","label":"Phone"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"conversationCreatedAt":"2026-06-18T12:05:41.3+00:00","assignedAt":"2026-06-18T12:06:02+00:00","contactPoint":{"id":"+18889100777"},"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415","label":"Amara Okafor"},"reason":{"id":"OfferAccepted","label":"Queue offers"},"conversationId":8123490,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"Email","label":"Email"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"assignedAt":"2026-06-19T10:31:17.8+00:00","contactPoint":{"id":"support@example.com"},"conversationCreatedAt":"2026-06-19T10:02:50+00:00","tags":[{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72","label":"refund"}],"agent":{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415","label":"Amara Okafor"},"reason":{"id":"ConversationClaimed","label":"Claims"},"conversationId":8123533,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/aiagents/records/{recordId}":{"post":{"tags":["Intelligence"],"summary":"Query AI agent records","description":"Get the rows of an AI agent record for a period. To get the next page, send the same query with `meta.next` as `pagination.pageKey`. Without filters, all AI agents are included, also deleted ones.","operationId":"postIntelligenceAiagentsRecordsRecordid","parameters":[{"name":"recordId","in":"path","description":"The id of an AI agent record","required":true,"schema":{"type":"string"},"examples":{"aiAgentFeedback · Interval · One AI agent":{"value":"aiAgentFeedback"},"aiAgentJoined · Preset · All AI agents, no labels":{"value":"aiAgentJoined"},"aiAgentToolCalls · Interval · One AI agent, chat only":{"value":"aiAgentToolCalls"}}}],"requestBody":{"description":"The query","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/AiAgentRecordDataRequest"}]},"examples":{"aiAgentFeedback · Interval · One AI agent":{"description":"`aiAgent` takes the AI agent ids from List filter values","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"aiAgent","values":["0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen","pagination":{"pageLimit":50},"includeLabels":true}},"aiAgentJoined · Preset · All AI agents, no labels":{"description":"Without filters, all AI agents are included, also deleted ones","value":{"primaryFilter":{"period":{"preset":"PreviousWeek"}},"timezone":"Europe/Copenhagen","includeLabels":false}},"aiAgentToolCalls · Interval · One AI agent, chat only":{"description":"AI agent records support the conversation filters, except `agent` and `team`","value":{"primaryFilter":{"period":{"interval":{"from":"2026-06-01T00:00:00Z","to":"2026-07-01T00:00:00Z"}}},"filters":[{"attribute":"aiAgent","values":["0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47"],"operator":"IsOne"},{"attribute":"channel","values":["Messenger"],"operator":"IsOne"}],"timezone":"Europe/Copenhagen"}}}}},"required":true},"responses":{"200":{"description":"One page of rows, and the keys of the previous and next pages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceRecordPage"},"examples":{"aiAgentFeedback · Interval · One AI agent":{"description":"One row per rating: a thumbs up and a thumbs down. The second conversation was in no queue, so it has no `queue`","value":{"data":[{"channel":{"id":"Messenger","label":"Messenger"},"aiAgent":{"id":"0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47","label":"Support assistant"},"submittedAt":"2026-06-20T10:42:13.208+00:00","tags":[{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72","label":"refund"}],"score":1,"responseId":"f3c9a1e7-62b4-4d8f-a5c0-8e2b7d41f693","feedbackType":{"id":"Thumbs","label":"Thumbs"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"conversationId":8123517,"initialDirection":{"id":"Inbound","label":"Inbound"}},{"channel":{"id":"Messenger","label":"Messenger"},"aiAgent":{"id":"0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47","label":"Support assistant"},"submittedAt":"2026-06-20T11:05:47.9+00:00","feedbackType":{"id":"Thumbs","label":"Thumbs"},"score":0,"responseId":"6a1d8e3b-07f2-4c95-b4e8-2d9f5a7c1e30","conversationId":8123529,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}},"aiAgentJoined · Preset · All AI agents, no labels":{"description":"One row per join. `agent` is the system user the AI agent acts as, and `variant` is only set for Mim AI agents","value":{"data":[{"channel":{"id":"Messenger"},"aiAgent":{"id":"0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47"},"queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90"},"joinedAt":"2026-06-20T10:41:02.5+00:00","variant":{"id":"Support"},"chatbotType":{"id":"Mim"},"systemUser":{"id":"5f2a9d61-c3e8-4b07-91d4-7e6b2a0c8f15"},"conversationId":8123517,"initialDirection":{"id":"Inbound"}}],"meta":{"pageLimit":50}}},"aiAgentToolCalls · Interval · One AI agent, chat only":{"description":"One row per tool call","value":{"data":[{"channel":{"id":"Messenger","label":"Messenger"},"tags":[{"id":"b3c81f6d-7a95-4e28-8c40-1f6b9d3a5e72","label":"refund"}],"aiAgent":{"id":"0b7e4c2d-5a91-4f38-b6e2-9d1c3a8f5e47","label":"Support assistant"},"calledAt":"2026-06-20T10:41:39.114+00:00","queue":{"id":"2f9b6d51-38c4-4a72-9e15-7c8b3f6a2d90","label":"Support"},"tool":{"id":"8d3f1b72-6e04-4a9c-b5d1-2c7e9f0a4b68","label":"Look up order"},"conversationId":8123517,"initialDirection":{"id":"Inbound","label":"Inbound"}}],"meta":{"pageLimit":50}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/intelligence/filters/{attribute}/values":{"get":{"tags":["Intelligence"],"summary":"List filter values","description":"List the values you can filter on for an attribute, such as all queues or all tags. Deactivated agents, queues and tags are included and marked with `deactivated: true`.","operationId":"getIntelligenceFiltersAttributeValues","parameters":[{"name":"attribute","in":"path","description":"A filter `attribute` from List metrics or List records","required":true,"schema":{"type":"string"}},{"name":"pageKey","in":"query","description":"The key of the page to fetch. To page through the results, call the link in `meta.next` or `meta.previous` of the previous response, which already carries this key.","required":false,"schema":{"type":"string"}},{"name":"pageLimit","in":"query","description":"The number of entries per page, up to 1000. Defaults to 50, or to the page size of `pageKey` when one is given.","required":false,"schema":{"default":50,"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The values of the filter attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelligenceFilterValuePage"},"examples":{"Entity values (agent)":{"description":"Agents with their display names. Deactivated agents are included and marked as deactivated","value":{"data":[{"id":"a4f1c0b2-6d38-4e91-8f27-1b5d9c3e7a04","label":"Joe Bloggs","deactivated":false},{"id":"c81d4e2a-95b7-4c60-a3f8-2e6a7d09b415","label":"Amara Okafor","deactivated":false},{"id":"e6b2a704-3f19-4d82-9c5b-4a8e1f2d7c36","label":"Sam Petrov","deactivated":true}],"meta":{"next":"/beta/intelligence/filters/agent/values?pageKey=eyJvZmZzZXQiOjUwLCJsaW1pdCI6NTB9&pageLimit=50"}}},"Enum values (channel)":{"description":"The id is the channel name, which can differ from the label. Channels have no `deactivated` flag","value":{"data":[{"id":"ContactForm","label":"Contact Form"},{"id":"Email","label":"Email"},{"id":"PstnPhone","label":"Phone"}]}},"Last page":{"description":"The page you get by following `meta.next`. There is no `next` on the last page","value":{"data":[{"id":"e6b2a704-3f19-4d82-9c5b-4a8e1f2d7c36","label":"Sam Petrov","deactivated":true}],"meta":{"previous":"/beta/intelligence/filters/agent/values?pageKey=eyJvZmZzZXQiOjAsImxpbWl0Ijo1MH0&pageLimit=50"}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/agents/presence":{"get":{"tags":["Agents"],"summary":"List presence","description":"List the presence status for all agents/admins in an organization.","operationId":"getAgentsPresence","responses":{"200":{"description":"The list of presence status for all agents/admins","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserPresence"}},"example":[{"userId":"d31a73fc-d67b-49ec-9534-1f36a0c4c906","requestTime":"2021-12-01T12:46:35.935","lastSeen":"2021-12-01T12:46:35.935","presenceStatus":"Working","connectionStatus":"Online","activeChannels":["Email","FacebookMessenger"]},{"userId":"8026cb51-184b-424f-8686-c6bc7bcf88eb","requestTime":"2021-12-01T12:46:35.935","lastSeen":"2021-12-01T12:46:35.935","presenceStatus":"Working","connectionStatus":"Online","activeChannels":["Email","FacebookMessenger","PstnPhone"]}]}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/agents":{"get":{"tags":["Agents"],"summary":"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.","operationId":"getAgents","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"The agent/admin email filter","required":false,"schema":{"type":"string"}},{"name":"phone","in":"query","description":"The agent/admin phone number filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of agents/admins","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAgentsOutput"},"example":{"data":[{"id":"93b885ad-fe0d-3089-8df6-34904fd59f71","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 0","email":"agent.0@example.org","avatarUrl":"https://files.dixa.io/public/image_0_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},{"id":"55a54008-ad1b-3589-aa21-0d2629c1df41","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 1","email":"agent.1@example.org","avatarUrl":"https://files.dixa.io/public/image_1_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},{"id":"9e688c58-a548-3b8e-af69-c9e1005ad0bf","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 2","email":"agent.2@example.org","avatarUrl":"https://files.dixa.io/public/image_2_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},{"id":"86666835-06aa-3d90-8bbd-5a74ac4edf68","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 3","email":"agent.3@example.org","avatarUrl":"https://files.dixa.io/public/image_3_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter email, Invalid value for: query parameter phone, Duplicate phone number, Duplicate email address, Invalid filters: Cannot provide both phone number and email address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"put":{"tags":["Agents"],"summary":"Update agents","description":"Bulk update agents/admins.","operationId":"putAgents","requestBody":{"description":"The list of agent/admin update actions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateAgentInput"}},"example":[{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","displayName":"Alice Brown","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"}]}},"required":false},"responses":{"200":{"description":"The list of update action outcomes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateAgentOutput"},"example":{"data":[{"data":{"id":"4d2ab456-8510-4a35-b266-e502160d5177","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","avatarUrl":"https://files.dixa.io/public/image_id","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"roles":["Agent"]},"_type":"BulkActionSuccess"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"post":{"tags":["Agents"],"summary":"Create agent","description":"Create an agent.","operationId":"postAgents","requestBody":{"description":"The agent's details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentInput"},"example":{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"}}},"required":true},"responses":{"201":{"description":"The created agent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentOutput"},"example":{"data":{"id":"4d2ab456-8510-4a35-b266-e502160d5177","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","avatarUrl":"https://files.dixa.io/public/image_id","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"roles":["Agent"]}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during agent creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"patch":{"tags":["Agents"],"summary":"Patch agents","description":"Bulk patch agents/admins.","operationId":"patchAgents","requestBody":{"description":"List of agent/admin patch actions","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BulkPatchAgentInput"}},"example":[{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","displayName":"AB","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[]},{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9c","displayName":"JB","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[]}]}},"required":false},"responses":{"200":{"description":"The list of patch action outcomes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateAgentOutput"},"example":{"data":[{"data":{"id":"4d2ab456-8510-4a35-b266-e502160d5177","createdAt":"2020-12-16T09:41:43Z","displayName":"AB","email":"jb@example.org","avatarUrl":"https://files.dixa.io/public/image_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},"_type":"BulkActionSuccess"},{"error":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9c","message":"Agent not found","_type":"NotFound"},"_type":"BulkActionFailure"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]}},"/beta/agents/{agentId}/teams":{"get":{"tags":["Agents"],"summary":"List teams","description":"List the teams in which the agent/admin is a member.","operationId":"getAgentsAgentidTeams","parameters":[{"name":"agentId","in":"path","description":"The agent/admin id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The list of teams in which the agent/admin is a member","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentTeamsOutput"},"example":{"data":[{"id":"e8ecd53b-2f6c-4471-a3a0-34d94caff8c8"},{"id":"4d2ab456-8510-4a35-b266-e502160d5177"}]}}}},"400":{"description":"Invalid value for: path parameter agentId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/agents/{agentId}/presence":{"get":{"tags":["Agents"],"summary":"Get presence","description":"Get the presence status for an agent/admin.","operationId":"getAgentsAgentidPresence","parameters":[{"name":"agentId","in":"path","description":"The agent/admin id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The agent/admin presence status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPresenceOutput"},"example":{"data":{"userId":"ec7f7e7b-b437-32ce-8681-45f71d37b53c","requestTime":"2021-12-01T12:46:35.935","lastSeen":"2021-12-01T12:46:35.935","presenceStatus":"Working","connectionStatus":"Online","activeChannels":["Email","FacebookMessenger"]}}}}},"400":{"description":"Invalid value for: path parameter agentId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/agents/bulk":{"post":{"tags":["Agents"],"summary":"Create agents","description":"Create agents in bulk.","operationId":"postAgentsBulk","requestBody":{"description":"The list of agent's details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentsInput"},"example":{"data":[{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"}]}}},"required":true},"responses":{"201":{"description":"The created agents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentsOutput"},"example":{"data":[{"data":{"id":"93b885ad-fe0d-3089-8df6-34904fd59f71","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 0","email":"agent.0@example.org","avatarUrl":"https://files.dixa.io/public/image_0_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},"_type":"BulkActionSuccess"},{"data":{"id":"55a54008-ad1b-3589-aa21-0d2629c1df41","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 1","email":"agent.1@example.org","avatarUrl":"https://files.dixa.io/public/image_1_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},"_type":"BulkActionSuccess"},{"data":{"id":"9e688c58-a548-3b8e-af69-c9e1005ad0bf","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 2","email":"agent.2@example.org","avatarUrl":"https://files.dixa.io/public/image_2_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},"_type":"BulkActionSuccess"},{"data":{"id":"86666835-06aa-3d90-8bbd-5a74ac4edf68","createdAt":"2020-12-16T09:41:43Z","displayName":"Agent 3","email":"agent.3@example.org","avatarUrl":"https://files.dixa.io/public/image_3_id","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"roles":["Agent"]},"_type":"BulkActionSuccess"},{"error":{"id":"e8ecd53b-2f6c-4471-a3a0-34d94caff8c8","message":"Create Agent [userId=...] in [orgId=...] failed with [errors=...]","_type":"Validation"},"_type":"BulkActionFailure"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]}},"/beta/agents/{agentId}":{"get":{"tags":["Agents"],"summary":"Get agent","description":"Get an agent/admin by id.","operationId":"getAgentsAgentid","parameters":[{"name":"agentId","in":"path","description":"The agent/admin id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The agent/admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentOutput"},"example":{"data":{"id":"4d2ab456-8510-4a35-b266-e502160d5177","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","avatarUrl":"https://files.dixa.io/public/image_id","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"roles":["Agent"]}}}}},"400":{"description":"Invalid value for: path parameter agentId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"put":{"tags":["Agents"],"summary":"Update agent","description":"Update an agent/admin.","operationId":"putAgentsAgentid","parameters":[{"name":"agentId","in":"path","description":"The agent id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The updated details for an agent/admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentInput"},"example":{"displayName":"Alice Brown","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":["Julia"],"avatarUrl":"http://avatar.url"}}},"required":true},"responses":{"200":{"description":"The updated agent/admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentOutput"},"example":{"data":{"id":"4d2ab456-8510-4a35-b266-e502160d5177","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","avatarUrl":"https://files.dixa.io/public/image_id","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":["Julia"],"roles":["Agent"]}}}}},"400":{"description":"Invalid value for: path parameter agentId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"delete":{"tags":["Agents"],"summary":"Delete agent","description":"Downgrade an agent/admin to become an end user.","operationId":"deleteAgentsAgentid","parameters":[{"name":"agentId","in":"path","description":"The agent/admin id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The agent/admin was successfully downgraded to end user"},"400":{"description":"Invalid value for: path parameter agentId, Invalid value extracted from request context, Validation failure during delete processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"patch":{"tags":["Agents"],"summary":"Patch agent","description":"Patch an agent/admin.","operationId":"patchAgentsAgentid","parameters":[{"name":"agentId","in":"path","description":"The agent/admin id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The agent/admin patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchAgentInput"},"example":{"displayName":"Alice Brown","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"}}},"required":true},"responses":{"200":{"description":"The patched agent/admin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentOutput"},"example":{"data":{"id":"4d2ab456-8510-4a35-b266-e502160d5177","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","avatarUrl":"https://files.dixa.io/public/image_id","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"roles":["Agent"]}}}}},"400":{"description":"Invalid value for: path parameter agentId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]}},"/beta/agents/{agentId}/presence/working-channel":{"put":{"tags":["Agents"],"summary":"Updates the working channel of an agent","description":"Updates the working channel of an agent","operationId":"putAgentsAgentidPresenceWorking-channel","parameters":[{"name":"agentId","in":"path","description":"The agent id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The state of the agent presence channel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAgentPresenceChannelInput"},"example":{"channel":"Speak","working":false}}},"required":true},"responses":{"204":{"description":"The working channel of the agent was successfully updated"},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member.presence.working_media"]}]}},"/beta/ai-agents":{"get":{"tags":["AI Agents"],"summary":"List AI agents","description":"Lists all AI agents in an organization. AI agents include Dixa's native Mim agents and external chatbot integrations.","operationId":"getAi-agents","responses":{"200":{"description":"The list of AI agents","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAiAgentsOutput"},"example":{"data":[{"id":"93b885ad-fe0d-3089-8df6-34904fd59f71","name":"Support Bot","systemUserId":"8277e091-0d75-3195-b448-797616e091ad","_type":"MimSupport"},{"id":"55a54008-ad1b-3589-aa21-0d2629c1df41","name":"Automation Bot","systemUserId":"e1671797-c52e-35f7-a338-0b45e841ec32","_type":"MimAutomation"},{"id":"9e688c58-a548-3b8e-af69-c9e1005ad0bf","name":"Ada Assistant","systemUserId":"8fa14cdd-754f-31cc-a554-c9e71929cce7","_type":"Ada"},{"id":"86666835-06aa-3d90-8bbd-5a74ac4edf68","name":"DigitalGenius Bot","systemUserId":"b2f5ff47-4366-31b6-a533-d8dc3614845d","_type":"Digitalgenius"},{"id":"ec7f7e7b-b437-32ce-8681-45f71d37b53c","name":"Kindly Bot","systemUserId":"2510c390-11c5-3e70-8182-423e3a695e91","_type":"Kindly"},{"id":"8bb6c178-3864-3f96-91cc-6a4de6c51709","name":"Generic API Bot","systemUserId":"865c0c0b-4ab0-3063-a5ca-a3387c1a8741","_type":"Genericapimessaging"}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/endusers":{"get":{"tags":["End Users"],"summary":"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}](../End-Users/#tag/End-Users/operation/getEndusersUserid) endpoint","operationId":"getEndusers","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Filter by the contact's email","required":false,"schema":{"type":"string"}},{"name":"phone","in":"query","description":"Filter by the contact's phone number","required":false,"schema":{"type":"string"}},{"name":"externalId","in":"query","description":"Filter by the contact's external id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of end users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEndUsersOutput"},"example":{"data":[{"id":"93b885ad-fe0d-3089-8df6-34904fd59f71","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 0","email":"enduser.0@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_0_id","externalId":"#12345678"},{"id":"55a54008-ad1b-3589-aa21-0d2629c1df41","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 1","email":"enduser.1@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_1_id","externalId":"#12345678"},{"id":"9e688c58-a548-3b8e-af69-c9e1005ad0bf","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 2","email":"enduser.2@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_2_id","externalId":"#12345678"},{"id":"86666835-06aa-3d90-8bbd-5a74ac4edf68","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 3","email":"enduser.3@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_3_id","externalId":"#12345678"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter email, Invalid value for: query parameter phone, Invalid value for: query parameter externalId, Duplicate phone number, Duplicate email address, Invalid filters: Cannot provide more than one filter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"put":{"tags":["End Users"],"summary":"Update end users","description":"Bulk update end users.","operationId":"putEndusers","requestBody":{"description":"List of end user update actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateEndUsersInput"},"example":{"data":[{"id":"d4826125-559f-496f-ad71-a0340f0cae06","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":["J."],"avatarUrl":"http://avatar.url","externalId":"#12345678"}]}}},"required":true},"responses":{"200":{"description":"The updated end users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateEndUsersOutput"},"example":{"data":[{"data":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":["J."],"avatarUrl":"https://files.dixa.io/public/image_id","externalId":"#12345678","customAttributes":[{"id":"4baa78bc-4815-4122-9c99-f71cd742d37b","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}]},"_type":"BulkActionSuccess"},{"error":{"id":"8fe8f4c3-7bc6-4767-924a-d9afa7ac7009","message":"Updating EndUser [id:8fe8f4c3-7bc6-4767-924a-d9afa7ac7009] failed with [errors:PhoneNumberExists]","_type":"Validation"},"_type":"BulkActionFailure"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"post":{"tags":["End Users","Chatbots"],"summary":"Create end user","description":"Create an end user.","operationId":"postEndusers","requestBody":{"description":"The end user's details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEndUserInput"},"example":{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url","externalId":"#12345678"}}},"required":true},"responses":{"201":{"description":"The created end user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEndUserOutput"},"example":{"data":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_id","externalId":"#12345678","customAttributes":[{"id":"4baa78bc-4815-4122-9c99-f71cd742d37b","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}]}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during enduser creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"patch":{"tags":["End Users"],"summary":"Patch end users","description":"Bulk patch end users.","operationId":"patchEndusers","requestBody":{"description":"List of end user patch actions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPatchEndUsersInput"},"example":{"data":[{"id":"43b1fe06-a7c4-4f34-8e48-b0559e6acdb9","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url","externalId":"#12345678"}]}}},"required":true},"responses":{"200":{"description":"The patched end users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkPatchEndUsersOutput"},"example":{"data":[{"data":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_id","externalId":"#12345678","customAttributes":[{"id":"4baa78bc-4815-4122-9c99-f71cd742d37b","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}]},"_type":"BulkActionSuccess"},{"error":{"id":"ace11abb-4ed0-42bd-9e3b-4ef6db58e0aa","message":"Updating EndUser [id=ace11abb-4ed0-42bd-9e3b-4ef6db58e0aa] in [org=b86a1842-437c-4c55-ac4b-0a9cd2f44dfb] failed with [errors=PhoneNumberExists]","_type":"Validation"},"_type":"BulkActionFailure"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]}},"/beta/endusers/bulk":{"post":{"tags":["End Users"],"summary":"Create end users","description":"Create multiple end users in a single bulk action","operationId":"postEndusersBulk","requestBody":{"description":"The list of end user details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEndUsersInput"},"example":{"data":[{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url","externalId":"#12345678"}]}}},"required":true},"responses":{"201":{"description":"The created end users","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEndUsersOutput"},"example":{"data":[{"data":{"id":"93b885ad-fe0d-3089-8df6-34904fd59f71","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 0","email":"enduser.0@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_0_id","externalId":"#12345678"},"_type":"BulkActionSuccess"},{"data":{"id":"55a54008-ad1b-3589-aa21-0d2629c1df41","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 1","email":"enduser.1@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_1_id","externalId":"#12345678"},"_type":"BulkActionSuccess"},{"data":{"id":"9e688c58-a548-3b8e-af69-c9e1005ad0bf","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 2","email":"enduser.2@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_2_id","externalId":"#12345678"},"_type":"BulkActionSuccess"},{"data":{"id":"86666835-06aa-3d90-8bbd-5a74ac4edf68","createdAt":"2020-12-16T09:41:43Z","displayName":"Enduser 3","email":"enduser.3@example.org","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_3_id","externalId":"#12345678"},"_type":"BulkActionSuccess"},{"error":{"id":"1b6d1e11-0626-414e-906a-b80a384cfef0","message":"Create EndUser [userId=...] in [orgId=...] failed with [errors=...]","_type":"Validation"},"_type":"BulkActionFailure"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]}},"/beta/endusers/{userId}":{"get":{"tags":["End Users","Chatbots"],"summary":"Get end user","description":"Get an end user by id.","operationId":"getEndusersUserid","parameters":[{"name":"userId","in":"path","description":"The end user id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The end user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEndUserOutput"},"example":{"data":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_id","externalId":"#12345678","customAttributes":[{"id":"4baa78bc-4815-4122-9c99-f71cd742d37b","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}]}}}}},"400":{"description":"Invalid value for: path parameter userId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"put":{"tags":["End Users"],"summary":"Update end user","description":"Update an end user.","operationId":"putEndusersUserid","parameters":[{"name":"userId","in":"path","description":"The end user id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The updated details for an end user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEndUserInput"},"example":{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":["J."],"avatarUrl":"http://avatar.url","externalId":"#12345678"}}},"required":true},"responses":{"200":{"description":"The updated end user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEndUserOutput"},"example":{"data":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":["J."],"avatarUrl":"https://files.dixa.io/public/image_id","externalId":"#12345678","customAttributes":[{"id":"4baa78bc-4815-4122-9c99-f71cd742d37b","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}]}}}}},"400":{"description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]},"patch":{"tags":["End Users"],"summary":"Patch end user","description":"Patch an end user.","operationId":"patchEndusersUserid","parameters":[{"name":"userId","in":"path","description":"The end user id to be patched","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The end user patch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchEndUserInput"},"example":{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url","externalId":"#12345678"}}},"required":true},"responses":{"200":{"description":"The patched end user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchEndUserOutput"},"example":{"data":{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","createdAt":"2020-12-16T09:41:43Z","displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"https://files.dixa.io/public/image_id","externalId":"#12345678","customAttributes":[{"id":"4baa78bc-4815-4122-9c99-f71cd742d37b","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}]}}}}},"400":{"description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.member"]}]}},"/beta/endusers/{userId}/anonymize":{"patch":{"tags":["End Users","Anonymization"],"summary":"Anonymize end user","description":"Request the anonymization of an end user.","operationId":"patchEndusersUseridAnonymize","parameters":[{"name":"userId","in":"path","description":"The id of the end user to anonymize","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"force","in":"query","description":"Whether to force close all the conversations initiated by the end user, if any are found in a non closed state.","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"202":{"description":"The end user's anonymization request status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizeEntityOutput"},"example":{"data":{"id":"6bf55369-a670-4e6b-9f70-ecdb9913549f","entityType":"UserAnonymizationType","_type":"User","initiatedAt":"2021-12-01T12:46:36.581Z[GMT]","targetEntityId":"f28fafd6-2e42-4441-943c-388a8e0ef433","requestedBy":"2b01e4c9-0c3a-47d4-9462-cd5a1a4687f5"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}}}},"security":[{"ApiKeyAuth":["anonymization"]}]}},"/beta/endusers/{userId}/custom-attributes":{"patch":{"tags":["End Users","Custom Attributes"],"summary":"Patch end user custom attributes","description":"Patch custom attributes of an end user","operationId":"patchEndusersUseridCustom-attributes","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The custom attributes of an end user to be patched. This should map the custom attribute id to the desired attribute value. Format: Map[UUID, Option[AttributeValue].","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Map_UUID_Option_AttributeValue"},"example":{"274e5a2c-be0d-42c0-b725-3dd533729f68":"abcdef","befae0d9-9679-42b9-af76-e76f64e28429":["example1","example2"]}}},"required":true},"responses":{"200":{"description":"The patched end user attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchEndUserCustomAttributesOutput"},"example":{"data":[{"id":"274e5a2c-be0d-42c0-b725-3dd533729f68","name":"End user attribute","identifier":"end_user_attribute","value":"abcdef"},{"id":"befae0d9-9679-42b9-af76-e76f64e28429","name":"End user attribute 2","identifier":"end_user_attribute_2","value":["example1","example2"]}]}}}},"400":{"description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"401":{"description":"The user who issued the access token used in the request is not authorized to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"},"example":{"message":"User is unauthorized to perform an underlying operation"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}},"security":[{"ApiKeyAuth":["contact.custom_attribute"]}]}},"/beta/endusers/{userId}/conversations":{"get":{"tags":["End Users","Chatbots"],"summary":"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}](../Conversations/#tag/Conversations/operation/getConversationsConversationid) endpoint","operationId":"getEndusersUseridConversations","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of conversations requested by an EndUser","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEndUserConversationsOutput"},"example":{"data":[{"id":1,"requesterId":"9deb936b-52e5-4c44-828d-4c8d48fe0c7e","channel":"WidgetChat","createdAt":"2020-12-16T09:41:43Z","direction":"Outbound","state":"Open","stateUpdatedAt":"2020-12-16T09:41:43Z","assignment":{"agentId":"0e4d0ead-dc69-470a-9b3a-e7eb16a56453","assignedAt":"2020-12-16T11:00:34Z"},"queue":{"id":"cd87b232-64c8-4ad5-b81a-6f9233352d97","queuedAt":"2020-12-16T10:40:40Z"},"browserInfo":{"name":"Chrome 9","version":"91.0.4472.114","ipAddress":"127.0.0.1","originatingUrl":"http://localhost:3000/"},"language":"en","link":{"parentId":1234,"_type":"SideConversation"},"_type":"ChatConversation"}]}}}},"400":{"description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/teams":{"get":{"tags":["Teams"],"summary":"List teams","description":"Lists all teams in an organization.","operationId":"getTeams","responses":{"200":{"description":"The list of teams in an organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTeamsOutput"},"example":{"data":[{"id":"005e7108-c85c-41d1-a945-4a8dc58c4399","name":"Team A"},{"id":"83cc3c21-9d28-4250-b6ea-b3a6333c5c73","name":"Team B"}]}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Teams"],"summary":"Create team","description":"Create a team.","operationId":"postTeams","requestBody":{"description":"The team name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamInput"},"example":{"name":"Team A"}}},"required":true},"responses":{"201":{"description":"The created team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamOutput"},"example":{"data":{"id":"005e7108-c85c-41d1-a945-4a8dc58c4399","name":"Team A"}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.team"]}]}},"/beta/teams/{teamId}/agents":{"get":{"tags":["Teams"],"summary":"List members","description":"Lists all agents/admins in a team.","operationId":"getTeamsTeamidAgents","parameters":[{"name":"teamId","in":"path","description":"The team id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of agents/admins in the specified team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTeamMembersOutput"},"example":{"data":[{"id":"e8333378-62ed-4062-93b5-fadae6f41175","name":"Agent A","email":"aa@example.org"},{"id":"40735745-9fde-4b6d-8941-e82e4e6d5001","name":"Agent B","email":"ab@example.org"}]}}}},"400":{"description":"Invalid value for: path parameter teamId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"delete":{"tags":["Teams"],"summary":"Remove members","description":"Remove agents/admins from a team.","operationId":"deleteTeamsTeamidAgents","parameters":[{"name":"teamId","in":"path","description":"The team id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"List of agent/admin ids to remove from the specified team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAgentsFromTeamInput"},"example":{"agentIds":["a8080cf3-9d55-41dd-a8ef-b02414399e7a","d53dbec1-e79c-4736-b9a1-15f6dce71ed4"]}}},"required":true},"responses":{"204":{"description":"The agents/admins were successfully removed from the team"},"400":{"description":"Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.team"]}]},"patch":{"tags":["Teams"],"summary":"Add members","description":"Add agents/admins to a team.","operationId":"patchTeamsTeamidAgents","parameters":[{"name":"teamId","in":"path","description":"The team id","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"List of agent/admin ids to add to the specified team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsToTeamInput"},"example":{"agentIds":["912d5148-6918-4420-b23a-8584b896c8ae","a8080cf3-9d55-41dd-a8ef-b02414399e7a"]}}},"required":true},"responses":{"200":{"description":""},"400":{"description":"Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/teams/{teamId}/presence":{"get":{"tags":["Teams"],"summary":"List presence","description":"List the presence status of all agents/admins in a team.","operationId":"getTeamsTeamidPresence","parameters":[{"name":"teamId","in":"path","description":"The team id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of agents/admins presence status in the specified team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPresenceOutput"},"example":{"data":[{"userId":"d53dbec1-e79c-4736-b9a1-15f6dce71ed4","requestTime":"2021-12-01T12:46:35.935","lastSeen":"2021-12-01T12:46:35.935","presenceStatus":"Working","connectionStatus":"Online","activeChannels":["Email","FacebookMessenger"]},{"userId":"e8ecd53b-2f6c-4471-a3a0-34d94caff8c8","requestTime":"2021-12-01T12:46:35.935","lastSeen":"2021-12-01T12:46:35.935","presenceStatus":"Working","connectionStatus":"Online","activeChannels":["Email","FacebookMessenger"]}]}}}},"400":{"description":"Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/teams/{teamId}":{"get":{"tags":["Teams"],"summary":"Get team","description":"Get a team by id.","operationId":"getTeamsTeamid","parameters":[{"name":"teamId","in":"path","description":"The team id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamOutput"},"example":{"data":{"id":"005e7108-c85c-41d1-a945-4a8dc58c4399","name":"Team A"}}}}},"400":{"description":"Invalid value for: path parameter teamId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}}},"delete":{"tags":["Teams"],"summary":"Delete team","description":"Delete a team.","operationId":"deleteTeamsTeamid","parameters":[{"name":"teamId","in":"path","description":"The team id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The team was successfully deleted"},"400":{"description":"Invalid value for: path parameter teamId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["organization.team"]}]}},"/beta/conversations/{conversationId}/anonymize":{"patch":{"tags":["Conversations","Anonymization"],"summary":"Anonymize conversation","description":"Request the anonymization of a conversation.","operationId":"patchConversationsConversationidAnonymize","parameters":[{"name":"conversationId","in":"path","description":"the id of the conversation to anonymize","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"force","in":"query","description":"Whether to force close the conversation if it is found in a non closed state.","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"202":{"description":"The conversation's anonymization request status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizeEntityOutput"},"example":{"data":{"id":"87bac308-e49f-4134-84cc-96b868f1e1e4","entityType":"ConversationAnonymizationType","_type":"Conversation","initiatedAt":"2021-12-01T12:46:36.581Z[GMT]","targetEntityId":"10749","requestedBy":"b165fdaa-51d6-44b0-bfcd-5f431d623fa7"}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: query parameter force","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}}}},"security":[{"ApiKeyAuth":["anonymization"]}]}},"/beta/conversations/{conversationId}/messages/{messageId}/anonymize":{"patch":{"tags":["Conversations","Messages","Anonymization"],"summary":"Anonymize message","description":"Request the anonymization of a single message in a conversation.","operationId":"patchConversationsConversationidMessagesMessageidAnonymize","parameters":[{"name":"conversationId","in":"path","description":"the id of the conversation in which the message belongs","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"messageId","in":"path","description":"the id of the message to anonymize","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"The message's anonymization request status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizeEntityOutput"},"example":{"data":{"id":"b165fdaa-51d6-44b0-bfcd-5f431d623fa7","entityType":"MessageAnonymizationType","_type":"Message","initiatedAt":"2021-12-01T12:46:36.581Z[GMT]","targetEntityId":"10749_1b9adc49-62f7-4056-a9c0-c18c1f25afdb","requestedBy":"4c7af391-b7fd-4560-9d82-b3464eef8776"}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter messageId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}},"500":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}}}},"security":[{"ApiKeyAuth":["anonymization"]}]}},"/beta/conversations/{conversationId}/close":{"put":{"tags":["Conversations","Chatbots"],"summary":"Close conversation","description":"Mark a conversation as closed by providing its id.","operationId":"putConversationsConversationidClose","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Specify the acting user for the close","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseConversationInput"},"example":{"userId":"5a556159-9c21-4f3e-a44f-d323deb80d16"}}},"required":false},"responses":{"204":{"description":"The conversation was successfully closed"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not admin, agent or AI agent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/followup":{"put":{"tags":["Conversations","Chatbots"],"summary":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp.","operationId":"putConversationsConversationidFollowup","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Specify the follow-up timestamp and acting user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FollowupConversationInput"},"example":{"timestamp":"2025-01-08T08:31:25Z","userId":"5a556159-9c21-4f3e-a44f-d323deb80d16"}}},"required":true},"responses":{"204":{"description":"The conversation was successfully followed up"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not admin, agent or AI agent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/reopen":{"put":{"tags":["Conversations"],"summary":"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.","operationId":"putConversationsConversationidReopen","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Specify the acting user for the reopen","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReopenConversationInput"},"example":{"userId":"a53b25da-f676-4c52-acac-58c9280aa23d"}}},"required":false},"responses":{"204":{"description":"The conversation was successfully reopened and offered in the same queue"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not admin, agent or AI agent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/transfer/queue":{"put":{"tags":["Conversations","Chatbots"],"summary":"Transfer conversation","description":"Transfer a conversation to a target queue.","operationId":"putConversationsConversationidTransferQueue","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Specify the target queue and acting user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferConversationInput"},"example":{"queueId":"92f8d193-b26f-4a62-86a3-bb03ee0915e9","userId":"a53b25da-f676-4c52-acac-58c9280aa23d"}}},"required":true},"responses":{"204":{"description":"The conversation was successfully transferred to the target queue"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not admin, agent or AI agent, Queue does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/notes/bulk":{"post":{"tags":["Conversations","Internal Notes"],"summary":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id.","operationId":"postConversationsConversationidNotesBulk","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The list of internal notes to create for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateInternalNoteInput"},"examples":{"Input with two internal notes created for the same conversation":{"value":{"data":[{"message":"A sample note","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","createdAt":"2021-12-01T12:46:36.581Z[GMT]"},{"message":"Another sample note"}]}}}}},"required":true},"responses":{"200":{"description":"The created internal notes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateNoteOutput"},"examples":{"A list of internal notes created successfully and error message for others which failed":{"value":{"data":[{"data":{"id":"eb31acbb-13f9-4ce7-abd3-44dd86266741","authorId":"5e8a300e-787e-47cd-af53-fc1ccc37933d","createdAt":"2021-12-01T12:46:36.581Z[GMT]","csid":9456,"message":"A sample note"},"_type":"BulkActionSuccess"},{"error":{"message":"An agent with id:... cannot be found in org."},"_type":"BulkActionFailure"}]}}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/notes":{"get":{"tags":["Conversations","Internal Notes"],"summary":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id.","operationId":"getConversationsConversationidNotes","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of internal notes for a conversation sorted from oldest to newest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInternalNotesOutput"},"example":{"data":[{"id":"3346b99c-8128-4276-ac40-5f30c959e5e7","authorId":"c68f42a5-1453-497a-940f-ff36ed4f1631","createdAt":"2021-01-20T09:00:00Z","csid":7392,"message":"A note to remember"},{"id":"22b8e6b6-4576-4dc0-ab05-60f81e8b0708","authorId":"124d54bb-92d6-41c9-a675-788d6a8c821e","createdAt":"2021-01-22T12:00:00Z","csid":7392,"message":"A note to forget"}]}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Conversations","Internal Notes"],"summary":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id.","operationId":"postConversationsConversationidNotes","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The internal note to create for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInternalNoteInput"},"examples":{"Input with createdAt":{"value":{"message":"A sample note","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","createdAt":"2021-12-01T12:46:36.581Z[GMT]"}},"Input without createdAt":{"value":{"message":"Another sample note"}}}}},"required":true},"responses":{"200":{"description":"The created internal note","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNoteOutput"},"examples":{"created internal note":{"value":{"data":{"id":"eb31acbb-13f9-4ce7-abd3-44dd86266741","authorId":"5e8a300e-787e-47cd-af53-fc1ccc37933d","createdAt":"2021-12-01T12:46:36.581Z[GMT]","csid":9456,"message":"A sample note"}}}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Agent was not found, Invalid date format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/ratings/{ratingId}/submit":{"post":{"tags":["Conversations","Ratings","Chatbots"],"summary":"Create conversation rating result","description":"Create a rating result for a specific conversation.","operationId":"postConversationsConversationidRatingsRatingidSubmit","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ratingId","in":"path","description":"The ratingId parameter has to be the ID of the offer created via invoking the /conversations/{conversationId}/ratings/offer endpoint.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The rating result to be created for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRatingResultInput"},"example":{"userId":"d3cf6f15-1497-4e71-92f2-9b3b228352bd","ratingResult":{"value":4,"_type":"Csat"},"comment":"Best customer service ever!","submittedAt":"2024-03-11T16:39:30Z"}}},"required":true},"responses":{"201":{"description":"The created conversation rating result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRatingResultOutput"},"example":{"data":{"ratingId":"33cf4e5e-9ce9-461c-b668-be9b712b717c","userId":"4c5f7efa-0822-4b75-bdf5-907fa7336e0c","ratingResult":{"value":5,"_type":"Csat"},"comment":"Excellent customer service!","submittedAt":"2024-03-11T16:39:30Z"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.satisfaction"]}]}},"/beta/conversations/{conversationId}/ratings/offer":{"post":{"tags":["Conversations","Ratings","Chatbots"],"summary":"Create conversation rating offer","description":"Create a rating offer for a specific conversation.","operationId":"postConversationsConversationidRatingsOffer","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The rating offer to be created for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRatingOfferInput"},"example":{"userId":"b0323b42-c428-4afa-970e-20bf5bdeeec4","agentId":"eeb3bbe5-0355-4ac1-8af5-20d42a3db24b","ratingType":"Csat","offeredAt":"2024-03-11T16:39:30Z"}}},"required":true},"responses":{"201":{"description":"The created conversation rating offer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRatingOfferOutput"},"example":{"data":{"id":"2f0122db-0824-44d7-b39a-e1f722b8c38c","userId":"7a65c963-b3ca-4bd4-996e-bdbcaa620219","agentId":"db7f0b41-b779-4726-a673-07b2a59a550d","ratingType":"Csat","offeredAt":"2024-03-11T16:39:30Z"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.satisfaction"]}]}},"/beta/conversations/{conversationId}/rating":{"get":{"tags":["Conversations","Ratings"],"summary":"List rating","description":"Deprecated rating endpoint. Use '/ratings'.","operationId":"getConversationsConversationidRating","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of ratings for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationRatingsOutput"},"example":{"data":[{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":4,"ratingType":"Csat","ratingComment":"Super good!","conversationChannel":"PstnPhone","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Offered","language":"English","timestamps":{}}]}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"deprecated":true}},"/beta/conversations/{conversationId}/ratings":{"get":{"tags":["Conversations","Ratings"],"summary":"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.","operationId":"getConversationsConversationidRatings","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of ratings for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListConversationRatingsOutput"},"examples":{"Response when a single question (CSAT) survey was offered":{"value":{"data":[{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":5,"ratingType":"Csat","ratingComment":"Super good!","conversationChannel":"PstnPhone","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Offered","language":"en","timestamps":{"offered_at":"2025-09-25T14:35:53Z","modified_at":"2025-09-25T14:36:27Z","scheduled_for":"2025-09-25T14:35:52Z","created_at":"2025-09-25T14:34:52Z","scheduled_at":"2025-09-25T14:34:52Z"}}]}},"Response when a multiple question survey was offered":{"value":{"data":[{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingType":"Nps","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Offered","language":"en","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z"}},{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingType":"Csat","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Offered","language":"en","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z"}},{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingType":"ThumbsUpOrDown","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Offered","language":"en","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z"}}]}},"Response when a multiple question survey was answered":{"value":{"data":[{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":8,"ratingType":"Nps","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Rated","language":"da","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","rated_at":"2025-10-10T10:46:40Z"}},{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":5,"ratingType":"Csat","ratingComment":"Super good!","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Rated","language":"da","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","rated_at":"2025-10-10T10:46:40Z"}},{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":1,"ratingType":"ThumbsUpOrDown","ratingComment":"Nice!","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Rated","language":"da","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","rated_at":"2025-10-10T10:46:40Z"}}]}},"Response when a multiple question survey was partially answered":{"value":{"data":[{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":8,"ratingType":"Nps","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Rated","language":"en","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","rated_at":"2025-10-12T12:46:40Z"}},{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":5,"ratingType":"Csat","ratingComment":"Super good!","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Offered","language":"en","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z"}},{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":1,"ratingType":"ThumbsUpOrDown","ratingComment":"Nice!","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Rated","language":"en","timestamps":{"offered_at":"2025-10-10T10:46:40Z","modified_at":"2025-10-10T10:46:40Z","created_at":"2025-10-10T10:46:40Z","scheduled_at":"2025-10-10T10:46:40Z","scheduled_for":"2025-10-10T10:46:40Z","rated_at":"2025-10-12T12:46:40Z"}}]}},"Response when offer and score was submitted via Dev API":{"value":{"data":[{"id":"33cf4e5e-9ce9-461c-b668-be9b712b717c","ratingScore":1,"ratingType":"ThumbsUpOrDown","ratingComment":"Nice!","conversationChannel":"Email","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","userId":"6d0c5791-e40a-46d4-bba1-1364ce4578ed","ratingStatus":"Rated","timestamps":{"rated_at":"2025-10-10T10:46:40Z"}}]}}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/conversations/activitylog":{"get":{"tags":["Conversations"],"summary":"List organization activity log","description":"List all activity logs for an organization.","operationId":"getConversationsActivitylog","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}},{"name":"fromDatetime","in":"query","description":"Starting date-time filter with ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDatetime","in":"query","description":"Ending date-time filter with ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The full list of activity logs for an organization with pagination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListActivityLogOutput"},"example":{"data":[{"id":"d85a7bd7-79da-4f10-b021-12e4c2c20024","conversationId":1,"activityTimestamp":"2021-12-01T12:46:36.581Z[GMT]","activityType":"ConversationAssignedActivityType","_type":"ConversationAssigned","author":{"id":"a53b25da-f676-4c52-acac-58c9280aa23d","name":"Dale Cooper","email":"dc@dixa.com","phoneNumber":"+4534343434"}},{"id":"324d0108-31b7-4678-8862-c8780a297f8f","conversationId":2,"activityTimestamp":"2021-12-01T12:46:36.581Z[GMT]","activityType":"ConversationAssignedActivityType","_type":"ConversationAssigned","author":{"id":"67ff39b6-b1ee-4d5f-91ee-168d4668c4ba","name":"Bob Ross","email":"br@dixa.com","phoneNumber":"+4532323232"}}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter fromDatetime, Invalid value for: query parameter toDatetime, Validation failure when retrieving data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/conversations/flows":{"get":{"tags":["Conversations"],"summary":"List flows","description":"List all conversations flows in an organization.","operationId":"getConversationsFlows","parameters":[{"name":"channel","in":"query","description":"An optional ConversationChannel can be specified to filter the flows. If not provided, the default channel is PstnPhone. Possible values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Email, ContactForm, Callback, PstnPhone, Messenger]","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of conversation flows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFlowsOutput"},"example":{"data":[{"id":"d546e9a8-82c2-409f-b688-e9199ea69f83","name":"Default call flow","channel":"PstnPhone","contactEndpointId":"+559912443333"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter channel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/conversations/{conversationId}/tags/{tagId}":{"put":{"tags":["Conversations","Tags"],"summary":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations.","operationId":"putConversationsConversationidTagsTagid","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The conversation was successfully tagged"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.tag"]}]},"delete":{"tags":["Conversations","Tags"],"summary":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation.","operationId":"deleteConversationsConversationidTagsTagid","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The conversation was successfully untagged"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.tag"]}]}},"/beta/conversations/{conversationId}/tags/bulk":{"post":{"tags":["Conversations","Tags"],"summary":"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.","operationId":"postConversationsConversationidTagsBulk","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The list of tags to add to a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTagConversationInput"},"example":{"data":[{"name":"Example #1"},{"name":"Example #2"}]}}},"required":true},"responses":{"202":{"description":"The conversation bulk tag was initiated"},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.tag"]}]}},"/beta/conversations/{conversationId}/tags":{"get":{"tags":["Conversations","Tags"],"summary":"List tags","description":"Get the tags for a particular conversation by providing the conversation id.","operationId":"getConversationsConversationidTags","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of tags for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationTagsOutput"},"example":{"data":[{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"}]}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/conversations/{conversationId}/messages":{"get":{"tags":["Conversations","Messages"],"summary":"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.","operationId":"getConversationsConversationidMessages","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"List of messages for a conversation sorted from oldest to newest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMessagesOutput"},"examples":{"Email messages example (Regular and TooLarge content)":{"value":{"data":[{"id":"11b95893-0514-4606-a5d8-1880172b3a55","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13244","createdAt":"2021-12-01T12:46:36.581Z[GMT]","attributes":{"emailContent":{"content":{"value":"Hello, this is a regular email content","_type":"Text"},"_type":"Regular"},"from":{"email":"some-help@email.dixa.io","name":"Help"},"to":[{"email":"someone@somecompany.com","name":"Some One"}],"cc":[],"bcc":[],"isAutoReply":false,"inlineImages":[{"url":"https://files.dixa.io/public/something/attachment/inline-image-1","prettyName":"image001.png"}],"attachments":[{"url":"https://files.dixa.io/private/something/attachment/attachment-1","prettyName":"Picture"}],"direction":"Outbound","originalContentUrl":{"url":"https://files.dixa.io/private/something/email_original_data/a1b2c3d4"},"_type":"EmailAttributes"}},{"id":"12c95893-0514-4606-a5d8-1880172b3a56","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13245","createdAt":"2021-12-01T12:47:36.581Z[GMT]","attributes":{"emailContent":{"file":{"url":"https://files.dixa.io/private/something/email_stripped_content/large-email-content","prettyName":"Large Email Content"},"_type":"TooLarge"},"from":{"email":"some-help@email.dixa.io","name":"Help"},"to":[{"email":"someone@somecompany.com","name":"Some One"}],"cc":[{"email":"manager@somecompany.com","name":"Manager"}],"bcc":[{"email":"archive@somecompany.com"}],"isAutoReply":false,"inlineImages":[],"attachments":[{"url":"https://files.dixa.io/private/something/attachment/attachment-2","prettyName":"Large Document"},{"url":"https://files.dixa.io/private/something/attachment/attachment-3","prettyName":"Spreadsheet"}],"direction":"Inbound","originalContentUrl":{"url":"https://files.dixa.io/private/something/email_original_data/b2c3d4e5"},"_type":"EmailAttributes"}}]}},"Chat message example":{"value":{"data":[{"id":"22b95893-0514-4606-a5d8-1880172b3a56","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13245","createdAt":"2021-12-01T12:47:36.581Z[GMT]","attributes":{"content":{"value":"How can I help you?","_type":"Text"},"direction":"Outbound","attachments":[],"isAutomated":false,"_type":"ChatAttributes"}}]}},"Contact form message example":{"value":{"data":[{"id":"33b95893-0514-4606-a5d8-1880172b3a57","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13246","createdAt":"2021-12-01T12:48:36.581Z[GMT]","attributes":{"emailContent":{"content":{"value":"Contact form submission","_type":"Text"},"_type":"Regular"},"from":{"email":"contact@example.com","name":"Contact Form"},"replyDefaultToEmails":[{"email":"support@company.com","name":"Support"}],"to":[{"email":"support@company.com","name":"Support"}],"cc":[],"bcc":[],"isAutoReply":false,"inlineImages":[],"attachments":[],"direction":"Inbound","_type":"ContactFormAttributes"}}]}},"Messenger form message example":{"value":{"data":[{"id":"44b95893-0514-4606-a5d8-1880172b3a58","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13247","createdAt":"2021-12-01T12:49:36.581Z[GMT]","attributes":{"formSubmission":{"values":{"Interests":["Product A"],"Name":"John Doe","Subject":"Product Inquiry","Email":"john.doe@example.com","Message":"I would like to know more about your services.","Preferred Contact":["Email"]}},"direction":"Inbound","content":{"value":"<form class=\\\"dixa-custom-form-submission\\\"><fieldset><legend class=\\\"dixa-custom-form-title\\\">Zarina's form</legend> <div class=\\\"dixa-custom-form-field\\\"><label class=\\\"dixa-custom-form-field-label\\\">Name<br/></label>\\n<div class=\\\"dixa-custom-form-field-value\\\">John Doe</div></div><div class=\\\"dixa-custom-form-spacing\\\"><br/></div><div class=\\\"dixa-custom-form-field\\\"><label class=\\\"dixa-custom-form-field-label\\\">Email<br/></label>\\n<div class=\\\"dixa-custom-form-field-value\\\">john.doe@example.com</div></div><div class=\\\"dixa-custom-form-spacing\\\"><br/></div><div class=\\\"dixa-custom-form-field\\\"><label class=\\\"dixa-custom-form-field-label\\\">Subject<br/></label>\\n<div class=\\\"dixa-custom-form-field-value\\\">Product Inquiry</div></div><div class=\\\"dixa-custom-form-spacing\\\"><br/></div><div class=\\\"dixa-custom-form-field\\\"><label class=\\\"dixa-custom-form-field-label\\\">Interests<br/></label>\\n<div class=\\\"dixa-custom-form-field-value\\\">Product B</div></div><div class=\\\"dixa-custom-form-spacing\\\"><br/></div><div class=\\\"dixa-custom-form-field\\\"><label class=\\\"dixa-custom-form-field-label\\\">Message<br/></label>\\n<div class=\\\"dixa-custom-form-field-value\\\">I would like to know more about your services.</div></div><div class=\\\"dixa-custom-form-spacing\\\"><br/></div><div class=\\\"dixa-custom-form-field\\\"><label class=\\\"dixa-custom-form-field-label\\\">Preferred Contact<br/></label>\\n<div class=\\\"dixa-custom-form-field-value\\\">email</div></div></fieldset></form>","_type":"Html"},"_type":"MessengerFormAttributes"}}]}},"Phone message example":{"value":{"data":[{"id":"55b95893-0514-4606-a5d8-1880172b3a59","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13248","createdAt":"2021-12-01T12:50:36.581Z[GMT]","attributes":{"from":"+1234567890","to":987654321,"direction":"Outbound","duration":120,"_type":"PhoneAttributes"}}]}},"Call recording message example":{"value":{"data":[{"id":"66b95893-0514-4606-a5d8-1880172b3a60","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13249","createdAt":"2021-12-01T12:51:36.581Z[GMT]","attributes":{"duration":180,"recording":"https://files.dixa.io/private/something/recording/call-1","_type":"CallRecordingAttributes"}}]}},"SMS message example":{"value":{"data":[{"id":"77b95893-0514-4606-a5d8-1880172b3a61","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13250","createdAt":"2021-12-01T12:52:36.581Z[GMT]","attributes":{"content":{"value":"SMS message content","_type":"Text"},"direction":"Inbound","attachments":[],"_type":"SmsAttributes"}}]}},"Facebook Messenger message example":{"value":{"data":[{"id":"88b95893-0514-4606-a5d8-1880172b3a62","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13251","createdAt":"2021-12-01T12:53:36.581Z[GMT]","attributes":{"content":{"value":"Facebook Messenger message","_type":"Text"},"direction":"Inbound","attachments":[],"_type":"FacebookMessengerAttributes"}}]}},"WhatsApp message example":{"value":{"data":[{"id":"99b95893-0514-4606-a5d8-1880172b3a63","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13252","createdAt":"2021-12-01T12:54:36.581Z[GMT]","attributes":{"content":{"value":"WhatsApp message","_type":"Text"},"direction":"Inbound","attachments":[],"_type":"WhatsAppAttributes"}}]}},"Generic message example":{"value":{"data":[{"id":"bbb95893-0514-4606-a5d8-1880172b3a65","authorId":"41646d42-edc0-493e-ac7b-814d9ff40a2e","externalId":"13254","createdAt":"2021-12-01T12:56:36.581Z[GMT]","attributes":{"content":{"value":"Generic message","_type":"Text"},"direction":"Inbound","attachments":[],"_type":"GenericAttributes"}}]}}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}}},"post":{"tags":["Conversations","Messages"],"summary":"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","operationId":"postConversationsConversationidMessages","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The message to be added to a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMessageInput"},"examples":{"General inbound example":{"summary":"General inbound example","value":{"content":{"value":"I need some help!","_type":"Html"},"attachments":[{"url":"http://attachment.url","prettyName":"Filename"}],"_type":"Inbound"}},"General outbound example":{"summary":"General outbound example","value":{"content":{"value":"Ok, I can help you!","_type":"Text"},"agentId":"bac5a02c-15b3-44da-ae1e-ab7b9db4aa89","attachments":[{"url":"http://attachment.url","prettyName":"Filename"}],"cc":[],"bcc":[],"_type":"Outbound"}},"Whatsapp outbound":{"summary":"Whatsapp outbound","value":{"content":{"value":"Hello dear **customer**! Here are *your* options:\\n* New item\\n* Refund\\n* Restock","_type":"Markdown"},"agentId":"359ef707-d77f-4298-a101-43da2d0c5770","attachments":[],"cc":[],"bcc":[],"_type":"Outbound"}},"Whatsapp outbound with attachments":{"summary":"Whatsapp outbound with attachments","value":{"content":{"value":"Hello dear **customer**! Here are *your* options:\\n* New item\\n* Refund\\n* Restock","_type":"Markdown"},"agentId":"359ef707-d77f-4298-a101-43da2d0c5770","attachments":[{"url":"https://file.hosting.service/file1234.jpg"}],"cc":[],"bcc":[],"_type":"Outbound"}}}}},"required":true},"responses":{"200":{"description":"The added message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMessageOutput"},"example":{"data":{"content":{"value":"An amazing message","_type":"Html"},"direction":"Outbound","authorId":"bac5a02c-15b3-44da-ae1e-ab7b9db4aa89","messageId":"87bac308-e49f-4134-84cc-96b868f1e1e4","createdAt":"2021-06-09T08:18:37.284Z"}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Duplicate externalId, Unsupported ConversationChannel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations":{"post":{"tags":["Conversations","Chatbots"],"summary":"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.","operationId":"postConversations","requestBody":{"description":"The conversation to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationInput"},"examples":{"Email":{"summary":"Email","value":{"requesterId":"9c2a2cce-699f-4a72-89d9-fda5bc8dec8b","emailIntegrationId":"my-integration@email.dixa.io","subject":"order #123","message":{"content":{"value":"My order hasn't shipped","_type":"Text"},"attachments":[],"_type":"Inbound"},"language":"en","_type":"Email"}},"WhatsApp":{"summary":"WhatsApp","value":{"requesterId":"9c2a2cce-699f-4a72-89d9-fda5bc8dec8b","contactEndpointId":"+15551234567","message":{"agentId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","template":{"templateId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","templateVariableMap":{"1":"12345"}}},"_type":"Whatsapp"}}}}},"required":true},"responses":{"201":{"description":"The id of the created conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversationOutput"},"example":{"data":{"id":100}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Duplicate externalId, Unsupported ConversationChannel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/import":{"post":{"tags":["Conversations","Chatbots"],"summary":"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.","operationId":"postConversationsImport","requestBody":{"description":"The type of conversation to import","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericConversationImport"},"examples":{"Generic API messaging conversation example":{"summary":"Generic API messaging conversation example","description":"The following example demonstrates how to import a conversation for the **genericapimessaging** channel. The key part is setting **genericChannelName** to **genericapimessaging**. This channel does not require any channel-specific **attributes**.","value":{"genericChannelName":"genericapimessaging","requesterId":"9c2a2cce-699f-4a72-89d9-fda5bc8dec8b","requesterConnectionStatus":"Connected","direction":"Inbound","messages":[{"content":{"value":"Hi, I need help with my order","_type":"Text"},"attachments":[],"createdAt":"2021-12-01T13:00:00.003Z","_type":"InboundImport"},{"content":{"value":"Sure — what seems to be the problem?","_type":"Text"},"agentId":"cd4ceb58-bb3a-443c-9cd8-4f088feafe5b","attachments":[],"createdAt":"2021-12-01T14:00:00.004Z","_type":"OutboundImport"}],"createdAt":"2021-12-01T11:00:00.001Z","assignment":{"agentId":"cd4ceb58-bb3a-443c-9cd8-4f088feafe5b","assignedAt":"2021-12-01T12:00:00.002Z"},"_type":"GenericConversationImport"}},"Email conversation example":{"summary":"Email conversation example","description":"The following example demonstrates how to import an email conversation. The key parts is the **genericChannelName** and the **attributes** fields. Please note that the **cc**, **bcc** and **requesterId** fields are optional. **cc** and **bcc** are only relevant for outbound messages, while **requesterId** message attribute is only relevant for inbound messages.","value":{"genericChannelName":"email","requesterId":"9c2a2cce-699f-4a72-89d9-fda5bc8dec8b","requesterConnectionStatus":"Connected","direction":"Inbound","messages":[{"content":{"value":"My order hasn't shipped","_type":"Text"},"attachments":[],"createdAt":"2021-12-01T13:00:00.003Z","attributes":{"emailIntegrationId":"sample-integration@email.dixa.io"},"_type":"InboundImport"},{"content":{"value":"Our bad, sorry","_type":"Text"},"agentId":"cd4ceb58-bb3a-443c-9cd8-4f088feafe5b","attachments":[{"url":"https://en.wikipedia.org/wiki/Shipwreck#/media/File:Titanic_wreck_bow.jpg","prettyName":"shipwreck"}],"createdAt":"2021-12-01T14:00:00.004Z","attributes":{"emailIntegrationId":"sample-integration@email.dixa.io","cc":["a@b.com","b@c.com"],"bcc":[]},"_type":"OutboundImport"},{"content":{"value":"Thank you!","_type":"Text"},"attachments":[],"createdAt":"2021-12-01T15:00:00.005Z","attributes":{"emailIntegrationId":"sample-integration@email.dixa.io","requesterId":"4f1f3a86-6b90-411a-9a3b-cf2e4c4cd7cd"},"_type":"InboundImport"}],"createdAt":"2021-12-01T11:00:00.001Z","assignment":{"agentId":"cd4ceb58-bb3a-443c-9cd8-4f088feafe5b","assignedAt":"2021-12-01T12:00:00.002Z"},"closing":{"closedAt":"2021-12-01T15:00:00.005Z","closedBy":"cd4ceb58-bb3a-443c-9cd8-4f088feafe5b"},"attributes":{"emailIntegrationId":"sample-integration@email.dixa.io","subject":"email subject"},"_type":"GenericConversationImport"}}}}},"required":true},"responses":{"201":{"description":"The id of the imported conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportConversationOutput"},"example":{"data":{"id":100,"partialErrors":[{"message":"The conversation could not be assigned"},{"message":"Invalid attachment url in message. externalId: 42"}]}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Unsupported ConversationChannel, Requester does not exist, Agent does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.import"]}]}},"/beta/conversations/{conversationId}/custom-attributes":{"patch":{"tags":["Conversations","Custom Attributes"],"summary":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation","operationId":"patchConversationsConversationidCustom-attributes","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The custom attributes of an conversation to be patched. This should map the custom attribute id to the desired attribute value. Format: Map[UUID, Option[AttributeValue].","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Map_UUID_Option_AttributeValue"},"example":{"2f5515b6-7e98-4f4d-9010-bfd2a27d4f35":"012345","e14708a6-eed9-495c-9d88-c72331e9e247":["str1","str2"]}}},"required":true},"responses":{"200":{"description":"The patched conversation attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchConversationCustomAttributesOutput"},"example":{"data":[{"id":"2f5515b6-7e98-4f4d-9010-bfd2a27d4f35","name":"Conversation attribute","identifier":"conversation_attribute","value":"012345"},{"id":"e14708a6-eed9-495c-9d88-c72331e9e247","name":"Conversation attribute 2","identifier":"conversation_attribute_2","value":["str1","str2"]}]}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"401":{"description":"The user who issued the access token used in the request is not authorized to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"},"example":{"message":"User is unauthorized to perform an underlying operation"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}},"security":[{"ApiKeyAuth":["conversation.custom_attribute"]}]}},"/beta/conversations/{conversationId}/claim":{"put":{"tags":["Conversations","Chatbots"],"summary":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the `force` paremeter to false","operationId":"putConversationsConversationidClaim","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClaimConversationInput"},"example":{"agentId":"5a556159-9c21-4f3e-a44f-d323deb80d16","force":false}}},"required":true},"responses":{"204":{"description":"The conversation was successfully claimed"},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"409":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}}},"security":[{"ApiKeyAuth":["conversation.claim"]}]}},"/beta/conversations/{conversationId}/activitylog":{"get":{"tags":["Conversations"],"summary":"List activity log","description":"Get the activity log for a conversation by providing the conversation id.","operationId":"getConversationsConversationidActivitylog","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Activity log entries for a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityLogOutput"},"example":{"data":[{"id":"fca291e5-8670-41bd-b502-842fd9542e27","conversationId":1,"activityTimestamp":"2021-12-01T12:46:36.581Z[GMT]","activityType":"ConversationAssignedActivityType","_type":"ConversationAssigned","author":{"id":"a53b25da-f676-4c52-acac-58c9280aa23d","name":"Dale Cooper","email":"dc@dixa.com","phoneNumber":"+4534343434"}}]}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/conversations/{conversationId}":{"get":{"tags":["Conversations"],"summary":"Get conversation","description":"Get a conversation by id.","operationId":"getConversationsConversationid","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConversationOutput"},"example":{"data":{"id":1,"requesterId":"d58c8b1c-85ad-4678-a6c8-7442945f3836","channel":"WidgetChat","createdAt":"2020-12-16T09:41:43Z","direction":"Outbound","state":"Open","stateUpdatedAt":"2020-12-16T09:41:43Z","assignment":{"agentId":"0e4d0ead-dc69-470a-9b3a-e7eb16a56453","assignedAt":"2020-12-16T11:00:34Z"},"queue":{"id":"cd87b232-64c8-4ad5-b81a-6f9233352d97","queuedAt":"2020-12-16T10:40:40Z"},"browserInfo":{"name":"Chrome 9","version":"91.0.4472.114","ipAddress":"127.0.0.1","originatingUrl":"http://localhost:3000/"},"language":"en","link":{"parentId":1234,"_type":"SideConversation"},"customAttributes":[{"id":"e14708a6-eed9-495c-9d88-c72331e9e247","name":"My Attribute","identifier":"my_attribute","value":"My Attribute Value"}],"_type":"ChatConversation"}}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/conversations/{conversationId}/link":{"put":{"tags":["Conversations"],"summary":"Link a conversation to a parent conversation","description":"Links the specified conversation to a parent conversation with the specified link type.\n\nLimitations:\n* Maximum of 100 child conversations per parent\n* Only 1 parent per child conversation\n* A child conversation cannot have its own child conversations","operationId":"putConversationsConversationidLink","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"The parent conversation ID and link type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkConversationInput"},"example":{"parentId":12345,"linkType":"SideConversation"}}},"required":true},"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["conversation.reply"]}]}},"/beta/conversations/{conversationId}/linked":{"get":{"tags":["Conversations"],"summary":"List linked conversations","description":"Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations.","operationId":"getConversationsConversationidLinked","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The list of conversations requested by an EndUser","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLinkedConversationsOutput"},"example":{"data":[{"id":12341,"requesterId":"7bcf1f2d-70c0-4f87-8c5b-bed2c8b247e9","channel":"WidgetChat","createdAt":"2022-07-26T12:09:21Z","direction":"Inbound","state":"Open","stateUpdatedAt":"2022-07-26T12:12:53Z","assignment":{"agentId":"01107a2e-4ff0-4a87-bb48-a19af298394d","assignedAt":"2022-07-26T12:12:53Z"},"queue":{"id":"6b9087b3-9ab7-4af4-936d-3290996faedb","queuedAt":"2022-07-26T12:09:54Z"},"toEmail":"something@email.dixa.com","fromEmail":"some.one@somewhere.com","integrationEmail":"something@email.dixa.com","language":"en","subject":"Important Request","link":{"parentId":1234,"_type":"SideConversation"},"_type":"EmailConversation"}]}}}},"400":{"description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/queues":{"get":{"tags":["Queues"],"summary":"List queues","description":"List all queues in an organization.","operationId":"getQueues","responses":{"200":{"description":"The list of queues in an organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListQueuesOutput"},"example":{"data":[{"id":"497d2cb4-6b48-4fa2-99d2-21c2a5bad79f","name":"MyCorp main queue","isDefault":true,"organizationId":"927d4b48-966b-45a3-8d7c-c6ad64f877b0","queueThresholds":{"SlaPercentage":10},"slaCalculationMethod":"AbandonedIgnored","offerTimeout":10,"offeringAlgorithm":"OneAtATimeRandom","memberListType":"SkillBased","usages":{"queueId":"497d2cb4-6b48-4fa2-99d2-21c2a5bad79f","usages":{"WidgetChat":["c6f50127-7f0a-418f-943e-c62b96d8a742","b2ac94ac-379a-4f24-995a-6473809eef6b"],"PstnPhone":["+4589977790"],"Email":["info@mycorp.dixa.io"]}},"wrapupTimeout":10,"priority":1,"offerAbandonedConversations":false,"doNotOfferTimeouts":{"WidgetChat":1},"isDoNotOfferEnabled":true,"isPreferredAgentEnabled":false,"preferredAgentTimeouts":{"WhatsApp":300,"Voicemail":300,"WidgetChat":300,"FacebookMessenger":300,"Email":43200,"ContactForm":43200,"Callback":300,"PstnPhone":300},"preferredAgentOfflineTimeout":500,"personalAgentOfflineTimeout":500,"isRestricted":false},{"id":"921a6e00-0845-417e-9c67-f7cb872d45f0","name":"MyCorp email queue","isDefault":true,"organizationId":"927d4b48-966b-45a3-8d7c-c6ad64f877b0","queueThresholds":{"SlaPercentage":10},"slaCalculationMethod":"AbandonedIgnored","offerTimeout":10,"offeringAlgorithm":"OneAtATimeRandom","memberListType":"SkillBased","usages":{"queueId":"921a6e00-0845-417e-9c67-f7cb872d45f0","usages":{"Email":["info@mycorp.dixa.io"]}},"wrapupTimeout":10,"priority":1,"offerAbandonedConversations":false,"doNotOfferTimeouts":{"WidgetChat":1},"isDoNotOfferEnabled":true,"isPreferredAgentEnabled":false,"preferredAgentOfflineTimeout":500,"personalAgentOfflineTimeout":500,"isRestricted":false}]}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Queues"],"summary":"Create queue","description":"Create a queue.","operationId":"postQueues","requestBody":{"description":"The details for creating a queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueInput"},"example":{"request":{"name":"MyCorp main queue","callFunctionality":false,"isDefault":true,"queueThresholds":{"WaitingConversations":10},"offerTimeout":10,"offerAlgorithm":"AllAtOnce","wrapupTimeout":10,"priority":1,"offerAbandonedConversations":false,"doNotOfferTimeouts":{"WidgetChat":1},"isDoNotOfferEnabled":true,"preferredAgentTimeouts":{"WhatsApp":300,"Voicemail":300,"WidgetChat":300,"FacebookMessenger":300,"Email":43200,"ContactForm":43200,"Callback":300,"PstnPhone":300},"isPreferredAgentEnabled":false,"preferredAgentOfflineTimeout":500,"personalAgentOfflineTimeout":500,"isRestricted":false}}}},"required":true},"responses":{"201":{"description":"The created queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQueueOutput"}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.queue:w"]}]}},"/beta/queues/{queueId}/members":{"get":{"tags":["Queues"],"summary":"List agents","description":"List all agents/admins that are members of a queue by providing the queue id.","operationId":"getQueuesQueueidMembers","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"List of the agents/admins that are members of a queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueMembersOutput"},"example":{"data":[{"agentId":"e96647c1-f697-4328-868a-19f828a6ee46","priority":1},{"agentId":"95dfa97e-dbf5-4bfc-be64-1f834baebd4e","priority":2}]}}}},"400":{"description":"Invalid value for: path parameter queueId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"delete":{"tags":["Queues"],"summary":"Remove agents","description":"Bulk remove agents/admins from the specified queue.","operationId":"deleteQueuesQueueidMembers","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The list of agents/admins to be removed from the queue. Up to 10 members can be specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkQueueEndpointInput"},"example":{"agentIds":["743c3781-c882-4352-a1fa-fe5d7a673cfd","cad2f234-8cec-4cd8-96e9-a6491a0176da"]}}},"required":true},"responses":{"204":{"description":"The bulk operation succeeded"},"400":{"description":"Invalid value for: path parameter queueId, Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.queue.members"]}]},"patch":{"tags":["Queues"],"summary":"Assign agents","description":"Assign one or more agents/admins to a given queue.","operationId":"patchQueuesQueueidMembers","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The list of agents/admins to be added to the queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkQueueEndpointInput"},"example":{"agentIds":["c31e5e3f-1d5f-4442-83df-fd7bddd59da4","26ae145b-8644-4fa5-aa56-7b3dcacbe2d4"]}}},"required":true},"responses":{"200":{"description":"The list of patch action outcomes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkQueueEndpointOutput"},"example":{"data":[{"data":"b41558f2-3807-44ef-8abf-a73d5ef68ff6","_type":"BulkActionSuccess"},{"error":{"id":"914a6e19-cab7-41a7-b41b-517e0ed56161","message":"User not found","_type":"NotFound"},"_type":"BulkActionFailure"},{"error":{"id":"7fecdb7e-9e37-45ef-be5e-0c14d6687aa0","message":"Member is neither Agent or Admin","_type":"Validation"},"_type":"BulkActionFailure"}]}}}},"400":{"description":"Invalid value for: path parameter queueId, Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.queue.members"]}]}},"/beta/queues/{queueId}/availability":{"get":{"tags":["Queues","Chatbots"],"summary":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging.","operationId":"getQueuesQueueidAvailability","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The availability of supported channels for a given queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueAvailabilityOutput"},"example":{"data":[{"channelAvailability":{"genericChannelName":"adachat","availability":"NotAvailable","queueSize":10,"_type":"GenericChannel"},"_type":"Success"},{"error":{"channel":"kindlychat","message":"Could not get availability for channel","_type":"UnexpectedError"},"_type":"Failure"}]}}}},"400":{"description":"Invalid value for: path parameter queueId, Invalid value extracted from request context ,queue does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"409":{"description":"The request could not be completed due to no supported channels configured for this organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conflict"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/queues/{queueId}":{"get":{"tags":["Queues"],"summary":"Get queue","description":"Get a queue by id.","operationId":"getQueuesQueueid","parameters":[{"name":"queueId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueueByIdOutput"},"example":{"data":{"id":"0bf82493-ae46-4c49-aa29-0422136269be","name":"MyCorp main queue","isDefault":true,"organizationId":"3de6c0f1-5e84-4d29-9ce9-84033983d4e6","queueThresholds":{"SlaPercentage":10},"slaCalculationMethod":"AbandonedIgnored","offerTimeout":10,"offeringAlgorithm":"OneAtATimeRandom","memberListType":"SkillBased","usages":{"queueId":"0bf82493-ae46-4c49-aa29-0422136269be","usages":{"WidgetChat":["c6f50127-7f0a-418f-943e-c62b96d8a742","b2ac94ac-379a-4f24-995a-6473809eef6b"],"PstnPhone":["+4589977790"],"Email":["info@mycorp.dixa.io"]}},"wrapupTimeout":10,"priority":1,"offerAbandonedConversations":false,"doNotOfferTimeouts":{"WidgetChat":1},"isDoNotOfferEnabled":true,"isPreferredAgentEnabled":false,"preferredAgentTimeouts":{"WhatsApp":300,"Voicemail":300,"WidgetChat":300,"FacebookMessenger":300,"Email":43200,"ContactForm":43200,"Callback":300,"PstnPhone":300},"preferredAgentOfflineTimeout":500,"personalAgentOfflineTimeout":500,"isRestricted":true}}}}},"400":{"description":"Invalid value for: path parameter queueId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/queues/conversation-position/{csid}":{"get":{"tags":["Queues","Chatbots"],"summary":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue.","operationId":"getQueuesConversation-positionCsid","parameters":[{"name":"csid","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"The position of the conversation in the queue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueuedConversationPositionOutput"},"example":{"data":{"position":10,"queuedAt":"2021-12-01T13:00:00.003Z"}}}}},"400":{"description":"Invalid value for: path parameter csid, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/tags":{"get":{"tags":["Tags"],"summary":"List tags","description":"List all tags in an organization. Only active tags are returned by default. To include deactivated tags use `?includeDeactivated=true`.","operationId":"getTags","parameters":[{"name":"includeDeactivated","in":"query","description":"Whether to include deactivated tags in the response. If not provided, only active tags are listed.","required":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"The list of all tags in an organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTagsOutput"},"example":{"data":[{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"},{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter includeDeactivated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Tags"],"summary":"Create tag","description":"Create a tag.","operationId":"postTags","requestBody":{"description":"The tag details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagInput"},"example":{"name":"test","color":"#000000"}}},"required":true},"responses":{"200":{"description":"The created tag or an existing tag with the same name. Note that the tag is not updated to match the input in case it already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagOutput"},"example":{"data":{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.tag"]}]}},"/beta/tags/{tagId}":{"get":{"tags":["Tags"],"summary":"Get tag","description":"Get a tag by id.","operationId":"getTagsTagid","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The tag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTagOutput"},"example":{"data":{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"}}}}},"400":{"description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"delete":{"tags":["Tags"],"summary":"Delete tag","description":"Deletes the tag and all its associations. Note that this operation is irreversible.","operationId":"deleteTagsTagid","parameters":[{"name":"tagId","in":"path","description":"The tag id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The tag was successfully deleted"},"400":{"description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.tag"]}]}},"/beta/tags/{tagId}/deactivate":{"patch":{"tags":["Tags"],"summary":"Deactivate tag","description":"Deactivate a tag.","operationId":"patchTagsTagidDeactivate","parameters":[{"name":"tagId","in":"path","description":"The tag id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The tag was successfully deactivated"},"400":{"description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.tag"]}]}},"/beta/tags/{tagId}/activate":{"patch":{"tags":["Tags"],"summary":"Activate tag","description":"Activate a tag.","operationId":"patchTagsTagidActivate","parameters":[{"name":"tagId","in":"path","description":"The tag id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The tag was successfully activated"},"400":{"description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.tag"]}]}},"/beta/anonymization/request/{requestId}":{"get":{"tags":["Anonymization"],"summary":"Get anonymization status","description":"Retrieve an anonymization request submitted earlier (user or conversation).","operationId":"getAnonymizationRequestRequestid","parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The anonymization request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizeEntityOutput"},"example":{"data":{"id":"062f0b37-4de0-40f2-95a4-641435cb2869","entityType":"UserAnonymizationType","_type":"User","initiatedAt":"2021-12-01T12:46:36.581Z[GMT]","targetEntityId":"da9db703-4a7a-4f44-8a6a-c03b179b8ae2","requestedBy":"bac5a02c-15b3-44da-ae1e-ab7b9db4aa89"}}}}},"400":{"description":"Invalid value for: path parameter requestId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"401":{"description":"The user who issued the access token used in the request is not authorized to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"},"example":{"message":"User is unauthorized to perform an underlying operation"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/anonymization":{"post":{"tags":["Anonymization"],"summary":"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.","operationId":"postAnonymization","requestBody":{"description":"A request to anonymize an entity in the system (user or conversation).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizeEntityInput"},"example":{"entityId":"a53b25da-f676-4c52-acac-58c9280aa23d","_type":"User"}}},"required":true},"responses":{"200":{"description":"The anonymization request status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonymizeEntityOutput"},"example":{"data":{"id":"a53b25da-f676-4c52-acac-58c9280aa23d","entityType":"UserAnonymizationType","_type":"User","initiatedAt":"2021-12-01T12:46:36.581Z[GMT]","targetEntityId":"6292b720-9dbd-4ff7-8942-f4e917cc1520","requestedBy":"062f0b37-4de0-40f2-95a4-641435cb2869"}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body, The entityId doesn't match the expected format for the specified type, The entity type is missing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"deprecated":true,"security":[{"ApiKeyAuth":["anonymization"]}]}},"/beta/contact-endpoints/{contactEndpointId}":{"get":{"tags":["Contact Endpoints"],"summary":"Get contact endpoint","description":"Get contact endpoint by id (email or phone number).","operationId":"getContact-endpointsContactendpointid","parameters":[{"name":"contactEndpointId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The requested contact endpoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactPointByIdOutput"},"example":{"data":{"address":"some@email.com","senderOverride":"otheremail@mail.dk","name":"Special email flow","_type":"EmailEndpoint"}}}}},"400":{"description":"Invalid value extracted from request context, The contactEndpointId is neither a valid email nor a valid E.164 phone number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}}}}},"/beta/contact-endpoints":{"get":{"tags":["Contact Endpoints"],"summary":"List contact endpoints","description":"List all available contact endpoints in an organization.","operationId":"getContact-endpoints","parameters":[{"name":"_type","in":"query","description":"An optional contact type can be specified to filter the contact endpoints. If not provided, all types are listed. Possible values: [EmailEndpoint, TelephonyEndpoint]","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of available contact endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactPointsOutput"},"example":{"data":[{"number":"+4531434343","functionality":["VoiceInbound","VoiceOutbound"],"name":"DK Sms","_type":"TelephonyEndpoint"},{"address":"some@email.com","senderOverride":"otheremail@mail.dk","name":"Special email flow","_type":"EmailEndpoint"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter _type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/custom-attributes/{customAttributeId}":{"get":{"tags":["Custom Attributes"],"summary":"Get custom attribute definition by id","description":"Get custom attribute in an organization by id.","operationId":"getCustom-attributesCustomattributeid","parameters":[{"name":"customAttributeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The configured custom attribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomAttributesDefinitionsOutput"},"example":{"data":{"id":"db5f673b-1c40-41e7-b71f-caab342f0607","entityType":"Conversation","identifier":"contact_reason","label":"Contact Reason","inputDefinition":{"options":[{"id":"5e2be744-cc2b-4bda-8c76-feb7b28f2970","label":"Payment","value":"payment","nestedOptions":[{"id":"666de4d5-0c6e-421c-a25e-d53073070af4","label":"Card","value":"card","nestedOptions":[],"isDeactivated":false,"orderIndex":2},{"id":"db26964a-5a88-4689-ad34-8a5f21cd9cd6","label":"Bank Transfer","value":"bank_transfer","nestedOptions":[],"isDeactivated":false,"orderIndex":3}],"isDeactivated":false,"orderIndex":1},{"id":"05d43b25-32a4-49e2-97c0-8723dc73f7bb","label":"Access","value":"access","nestedOptions":[],"isDeactivated":false,"orderIndex":4}],"_type":"Select"},"description":"Reason for contacting","createdAt":"2023-01-05T06:42:31.532Z[GMT]","isRequired":true,"isArchived":false,"isDeactivated":false}}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/custom-attributes":{"get":{"tags":["Custom Attributes"],"summary":"List custom attributes definitions","description":"List all custom attributes in an organization.","operationId":"getCustom-attributes","responses":{"200":{"description":"The list of configured custom attributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCustomAttributesDefinitionsOutput"},"example":{"data":[{"id":"c43fc767-f89b-443a-9c98-90f53f940bd7","entityType":"Conversation","identifier":"parcel_id","label":"Parcel ID","inputDefinition":{"placeholder":"1234","_type":"Text"},"description":"Id of the parcel","createdAt":"2023-01-01T08:23:54.246Z[GMT]","updatedAt":"2023-01-11T12:25:23.837Z[GMT]","isRequired":false,"isArchived":false,"isDeactivated":false},{"id":"db5f673b-1c40-41e7-b71f-caab342f0607","entityType":"Conversation","identifier":"contact_reason","label":"Contact Reason","inputDefinition":{"options":[{"id":"5e2be744-cc2b-4bda-8c76-feb7b28f2970","label":"Payment","value":"payment","nestedOptions":[{"id":"666de4d5-0c6e-421c-a25e-d53073070af4","label":"Card","value":"card","nestedOptions":[],"isDeactivated":false,"orderIndex":2},{"id":"db26964a-5a88-4689-ad34-8a5f21cd9cd6","label":"Bank Transfer","value":"bank_transfer","nestedOptions":[],"isDeactivated":false,"orderIndex":3}],"isDeactivated":false,"orderIndex":1},{"id":"05d43b25-32a4-49e2-97c0-8723dc73f7bb","label":"Access","value":"access","nestedOptions":[],"isDeactivated":false,"orderIndex":4}],"_type":"Select"},"description":"Reason for contacting","createdAt":"2023-01-05T06:42:31.532Z[GMT]","isRequired":true,"isArchived":false,"isDeactivated":false},{"id":"66121f54-98ee-4727-a4e7-1a373d411ccf","entityType":"Contact","identifier":"location","label":"Location","inputDefinition":{"options":[{"id":"6c5efa22-8b49-4205-bb7c-52e86af3a369","label":"Denmark","value":"denmark","nestedOptions":[{"id":"ac4e65ea-7b84-4889-a3b5-b957926178c6","label":"Copenhagen","value":"copenhagen","nestedOptions":[],"isDeactivated":false,"orderIndex":6},{"id":"35fa047e-c1f2-4d8d-be54-2adb7d326781","label":"Aarhus","value":"aarhus","nestedOptions":[],"isDeactivated":false,"orderIndex":7}],"isDeactivated":false,"orderIndex":5}],"_type":"Select"},"description":"End user's known city","createdAt":"2023-01-01T08:25:50.246Z[GMT]","updatedAt":"2023-02-01T09:01:52.2Z[GMT]","isRequired":false,"isArchived":false,"isDeactivated":false}]}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/search/conversations":{"get":{"tags":["Search","Conversations"],"summary":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text.","operationId":"getSearchConversations","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","description":"The text by which to search conversations","required":true,"schema":{"type":"string","minLength":1},"example":"cancel my order"},{"name":"exactMatch","in":"query","description":"Return only exact matches. This value is false by default.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"The search results for the searched parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchOutput"},"example":{"data":[{"id":1234,"highlights":{"subject":["<em class=\"highlight\">Cancel my order</em>"]},"innerHits":[]}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter query, Invalid value for: query parameter exactMatch","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"401":{"description":"The user who issued the access token used in the request is not authorized to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"},"example":{"message":"User is unauthorized to perform an underlying operation"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"deprecated":true},"post":{"tags":["Search","Conversations"],"summary":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both","operationId":"postSearchConversations","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"The filters to apply to the search","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchParametersInput"},"examples":{"Find conversations that include one of two tags":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"values":["177e7564-6434-4177-a25a-8530089196ad","7729e7564-9876-a637-b46b-8530038196b3"],"_type":"IncludesOne"},"_type":"TagId"}}]}}},"Find conversations that contain any tags":{"value":{"query":{"value":"order 12345","exactMatch":true},"filters":{"strategy":"All","conditions":[{"field":{"operator":{"_type":"IsNotEmpty"},"_type":"TagId"}}]}}},"Find conversations that contain all specified tags and contains specific text":{"value":{"query":{"value":"order 12345","exactMatch":true},"filters":{"strategy":"All","conditions":[{"field":{"operator":{"values":["177e7564-6434-4177-a25a-8530089196ad","7729e7564-9876-a637-b46b-8530038196b3"],"_type":"IncludesAll"},"_type":"TagId"}}]}}},"Find conversations with custom attribute of type Text":{"value":{"query":{"value":"delivery","exactMatch":true},"filters":{"strategy":"All","conditions":[{"field":{"operator":{"values":[["PK461926232"],["PK461926233"],["PK461926234"]],"_type":"IsOneOf"},"attributeId":"1fba54c0-3ef6-48c8-bf00-912c5c9890fd","_type":"CustomAttribute"}}]}}},"Find conversations with custom attribute of type Select":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"values":[["cookies"],["chocolate","chocolate_bar","with_nuts","peanuts"],["tart","nut_tart","hazelnuts"]],"_type":"IsOneOf"},"attributeId":"30cd8aa4-3b58-4d70-a716-887dd6f348b4","_type":"CustomAttribute"}}]}}},"Find conversations where custom attribute is not set":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"_type":"IsEmpty"},"attributeId":"1fba54c0-3ef6-48c8-bf00-912c5c9890fd","_type":"CustomAttribute"}}]}}},"Find conversations with duration between 10 and 20 seconds":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"min":10000,"max":20000,"_type":"Between"},"_type":"Duration"}}]}}},"Find conversations with last message since specified time":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"timestamp":"2023-02-11T22:59:59.999Z","_type":"Since"},"_type":"LastMessage"}}]}}},"Find conversations in a specific queue and with last activity until certain date":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"values":["6f2e0d7f-d7e2-408e-93df-3c43f0a070c3"],"_type":"IsOneOf"},"_type":"QueueId"}},{"field":{"operator":{"timestamp":"2023-02-11T22:59:59.999Z","_type":"Until"},"_type":"LastActivity"}}]}}},"Find conversations with creation date between two timestamps or closed date between two timestamps":{"value":{"filters":{"strategy":"Any","conditions":[{"field":{"operator":{"timestampFrom":"2023-02-11T22:59:59.999Z","timestampTo":"2023-02-11T23:59:59.999Z","_type":"Between"},"_type":"CreationDate"}},{"field":{"operator":{"timestampFrom":"2023-02-11T22:59:59.999Z","timestampTo":"2023-02-11T23:59:59.999Z","_type":"Between"},"_type":"ClosedDate"}}]}}},"Find conversations with direction Inbound and channel Phone or SMS":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"values":["inbound"],"_type":"IsOneOf"},"_type":"Direction"}},{"field":{"operator":{"values":["phone","sms"],"_type":"IsOneOf"},"_type":"Channel"}}]}}}}}},"required":false},"responses":{"200":{"description":"The search results for the searched parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchConversationsWithFiltersOutput"},"examples":{"Results when query was not provided and next page is available":{"value":{"data":[{"id":1234,"highlights":{}},{"id":2345,"highlights":{}},{"id":3456,"highlights":{}}],"meta":{"next":"/<api-version>/search/conversations/?pageKey=cGFnZUxpbWl0PTUwJnBhZ2U9MQ%3D%3D:"}}},"Results when query was provided and no more pages are available":{"value":{"data":[{"id":1212,"highlights":{"subject":["<em class=\"highlight\">Cancel my order</em>"]}},{"id":1234,"highlights":{"subject":["<em class=\"highlight\">Cancel my order</em>"]}}]}}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"401":{"description":"The user who issued the access token used in the request is not authorized to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized"},"example":{"message":"User is unauthorized to perform an underlying operation"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/webhooks/{webhookSubscriptionId}":{"get":{"tags":["Webhooks"],"summary":"Webhook Subscription","description":"Get a Webhook Subscription by ID.","operationId":"getWebhooksWebhooksubscriptionid","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The Webhook Subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookSubscriptionOutput"},"example":{"data":{"id":"cb452b81-6748-40ab-af85-6559b371bc5d","name":"Dashboard Integration","subscribedEvents":["ConversationCreated","ConversationClosed"],"url":"https://example.webhook/dashboard_integration","headers":{"Authorization":"Basic d2ViaG9va191c2VyOndlYmhvb2tfcGFzc3dvcmQ="},"secretKey":"4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc","enabled":true,"createdAt":"2023-08-01T09:30:15Z","createdBy":"e979cc3b-17b2-4850-b049-13c758763d1c","updatedAt":"2023-08-02T15:09:30Z","updatedBy":"64b777c3-eb82-49fb-bb3e-294afb5d840c","filters":{"Conversation":{"strategy":"All","conditions":[{"field":"InitialChannel","values":["email","pstn_phone"],"_type":"IsOneOf"},{"field":"QueueId","values":["f0475e4c-64ae-4c8e-8644-4ed10dc8d752"],"_type":"IsNotOneOf"},{"field":"OperationOrigin","values":["ApiImport"],"_type":"IsNotOneOf"}],"_type":"CombinedFilters"}}}}}}},"400":{"description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"delete":{"tags":["Webhooks"],"summary":"Delete Webhook Subscription","description":"Delete a Webhook Subscription.","operationId":"deleteWebhooksWebhooksubscriptionid","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The Webhook Subscription was successfully deleted"},"400":{"description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.integration.api"]}]},"patch":{"tags":["Webhooks"],"summary":"Patch Webhook Subscription","description":"Patch a Webhook Subscription.","operationId":"patchWebhooksWebhooksubscriptionid","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The Webhook Subscription fields to be patched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchWebhookSubscriptionInput"},"example":{"name":"New name","events":["ConversationNoteAdded"],"authorization":{"value":"eyDoiGciOqGYUzI1NiJ4.eyJ0eQJRUapoYXBpIiwib4JxA5lkIjoiNTVmMmE6MmItYjU4NF33MDMxLTk2NTktOTE2M.qPoOZoQYDn4rn-akaLmVFka15JAV7TF6QT8UHOUTIy0","_type":"TokenAuth"},"customHeaders":{"X-Automation-Webhook-Token":"<TOKEN>","X-Example-Header":"ExampleValue"},"filters":{"Conversation":{"strategy":"All","conditions":[{"field":"InitialChannel","values":["email","pstn_phone"],"_type":"IsOneOf"},{"field":"QueueId","values":["f0475e4c-64ae-4c8e-8644-4ed10dc8d752"],"_type":"IsNotOneOf"},{"field":"OperationOrigin","values":["ApiImport"],"_type":"IsNotOneOf"}],"_type":"CombinedFilters"}}}}},"required":true},"responses":{"200":{"description":"The patched Webhook Subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchWebhookSubscriptionOutput"},"example":{"data":{"id":"cb452b81-6748-40ab-af85-6559b371bc5d","name":"New name","subscribedEvents":["ConversationNoteAdded"],"url":"https://example.webhook/dashboard_integration","headers":{"Authorization":"Bearer eyDoiGciOqGYUzI1NiJ4.eyJ0eQJRUapoYXBpIiwib4JxA5lkIjoiNTVmMmE6MmItYjU4NF33MDMxLTk2NTktOTE2M.qPoOZoQYDn4rn-akaLmVFka15JAV7TF6QT8UHOUTIy0"},"secretKey":"4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc","enabled":true,"createdAt":"2023-08-01T09:30:15Z","createdBy":"e979cc3b-17b2-4850-b049-13c758763d1c","updatedAt":"2023-08-02T15:09:30Z","updatedBy":"64b777c3-eb82-49fb-bb3e-294afb5d840c","filters":{"Conversation":{"strategy":"All","conditions":[{"field":"InitialChannel","values":["email","pstn_phone"],"_type":"IsOneOf"},{"field":"QueueId","values":["f0475e4c-64ae-4c8e-8644-4ed10dc8d752"],"_type":"IsNotOneOf"},{"field":"OperationOrigin","values":["ApiImport"],"_type":"IsNotOneOf"}],"_type":"CombinedFilters"}}}}}}},"400":{"description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context, Invalid value for: body, Validation failure during Webhook Subscription patching","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.integration.api"]}]}},"/beta/webhooks":{"get":{"tags":["Webhooks"],"summary":"List all Webhook Subscriptions","description":"List of all Webhook Subscriptions in an organization.","operationId":"getWebhooks","responses":{"200":{"description":"The List of Webhook Subscriptions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWebhookSubscriptionsEndpointOutput"},"example":{"data":[{"id":"cb452b81-6748-40ab-af85-6559b371bc5d","name":"Dashboard Integration","subscribedEvents":["ConversationCreated","ConversationClosed"],"url":"https://example.webhook/dashboard_integration","headers":{"Authorization":"Basic d2ViaG9va191c2VyOndlYmhvb2tfcGFzc3dvcmQ="},"secretKey":"4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc","enabled":true,"createdAt":"2023-08-01T09:30:15Z","createdBy":"e979cc3b-17b2-4850-b049-13c758763d1c","updatedAt":"2023-08-02T15:09:30Z","updatedBy":"64b777c3-eb82-49fb-bb3e-294afb5d840c","filters":{"Conversation":{"strategy":"All","conditions":[{"field":"InitialChannel","values":["email","pstn_phone"],"_type":"IsOneOf"},{"field":"QueueId","values":["f0475e4c-64ae-4c8e-8644-4ed10dc8d752"],"_type":"IsNotOneOf"},{"field":"OperationOrigin","values":["ApiImport"],"_type":"IsNotOneOf"}],"_type":"CombinedFilters"}}}]}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Webhooks"],"summary":"Create Webhook Subscription","description":"Create a Webhook Subscription.","operationId":"postWebhooks","requestBody":{"description":"The Webhook Subscription to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookSubscriptionInput"},"example":{"name":"Dashboard Integration","events":["ConversationCreated","ConversationClosed"],"url":"https://example.webhook/dashboard_integration","authorization":{"username":"webhook_user","password":"webhook_password","_type":"BasicAuth"},"customHeaders":{"X-Automation-Webhook-Token":"<TOKEN>","X-Example-Header":"ExampleValue"},"enabled":true,"filters":{"Conversation":{"strategy":"All","conditions":[{"field":"InitialChannel","values":["email","pstn_phone"],"_type":"IsOneOf"},{"field":"QueueId","values":["f0475e4c-64ae-4c8e-8644-4ed10dc8d752"],"_type":"IsNotOneOf"},{"field":"OperationOrigin","values":["ApiImport"],"_type":"IsNotOneOf"}],"_type":"CombinedFilters"}}}}},"required":true},"responses":{"201":{"description":"The created Webhook Subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookSubscriptionOutput"},"example":{"data":{"id":"cb452b81-6748-40ab-af85-6559b371bc5d","name":"Dashboard Integration","subscribedEvents":["ConversationCreated","ConversationClosed"],"url":"https://example.webhook/dashboard_integration","headers":{"Authorization":"Basic d2ViaG9va191c2VyOndlYmhvb2tfcGFzc3dvcmQ="},"secretKey":"4g4h988p468g785965b780684bde5546c52gge658d76b4q33fb69c526ea4bdbc","enabled":true,"createdAt":"2023-08-01T09:30:15Z","createdBy":"e979cc3b-17b2-4850-b049-13c758763d1c","updatedAt":"2023-08-02T15:09:30Z","updatedBy":"64b777c3-eb82-49fb-bb3e-294afb5d840c","filters":{"Conversation":{"strategy":"All","conditions":[{"field":"InitialChannel","values":["email","pstn_phone"],"_type":"IsOneOf"},{"field":"QueueId","values":["f0475e4c-64ae-4c8e-8644-4ed10dc8d752"],"_type":"IsNotOneOf"},{"field":"OperationOrigin","values":["ApiImport"],"_type":"IsNotOneOf"}],"_type":"CombinedFilters"}}}}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during Webhook Subscription creation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.integration.api"]}]}},"/beta/webhooks/{webhookSubscriptionId}/delivery-status":{"get":{"tags":["Webhooks"],"summary":"Webhook Subscription Last Delivery Statuses","description":"Get the latest delivery statuses of a Webhook Subscription.","operationId":"getWebhooksWebhooksubscriptionidDelivery-status","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The Latest Delivery Statuses of a Webhook Subscription","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookLastDeliveryStatusOutput"},"example":{"data":[{"event":"ConversationCreated","deliveryStatus":{"deliveryTimestamp":"2023-09-15T12:00:00.000Z","success":true,"responseCode":200,"responseText":"OK","_type":"DeliveryDetail"}},{"event":"ConversationClosed","deliveryStatus":{"_type":"NoRecentDelivery"}}]}}}},"400":{"description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}":{"get":{"tags":["Webhooks"],"summary":"Webhook Subscription Event Logs","description":"Get the latest Webhook Subscription Event logs.","operationId":"getWebhooksWebhooksubscriptionidDelivery-statusLogsEvent","parameters":[{"name":"webhookSubscriptionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"event","in":"path","description":"The set of events this Webhook Subscription subscribes to. Allowed values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The Webhook Subscription Event Logs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebhookEventDeliveryLogsOutput"},"example":{"data":[{"deliveryDetail":{"deliveryTimestamp":"2023-09-15T12:00:00.000Z","success":true,"responseCode":200,"responseText":"OK"},"payload":"{ \"event_id\": \"8967e0c6-fe64-4105-bf71-14ae0c256gg4\", \"event_fqn\": \"CONVERSATION_NOTE_ADDED\", \"event_version\": \"1\", \"event_timestamp\": \"2023-09-15T12:00:00.000Z\", \"organization\": { \"id\": \"g1b15dq2-bba8-48a8-a92e-852014a166r9\", \"name\": \"Your Org Name\" }, \"data\": { \"conversation\": { \"csid\": 1234, \"channel\": \"WIDGET_CHAT\", \"status\": \"OPEN\", \"direction\": \"INBOUND\", \"queue\": { \"id\": \"b5b10483-7d28-4dea-bf8d-0d88cc3bd7cc\", \"name\": \"Your Queue\" }, \"contact_point\": \"Your Contact Point\", \"requester\": { \"id\": \"ec4a2b65-0403-42b3-b054-8998325fd8ac\", \"name\": \"Test Requester\", \"email\": \"test@example.com\", \"phone\": null, \"roles\": [ \"Enduser\" ] }, \"assignee\": { \"id\": \"cccb8520-e24f-43bf-8344-49d07665d854\", \"name\": \"An Agent\", \"email\": \"agent@yourcompany.com\", \"phone\": \"+4511223344\", \"roles\": [ \"Admin\", \"TeamLead\", \"SystemAdmin\", \"Agent\" ] }, \"subject\": null, \"tags\": [], \"created_at\": \"2023-09-01T12:00:00.000Z\" }, \"note_id\": \"ac951357-5189-4707-add7-616af55698q7\", \"text\": \"Some Note Added\", \"created_at\": \"2023-09-15T12:00:00.000Z\", \"author\": { \"id\": \"cccb8520-e24f-43bf-8344-49d07665d854\", \"name\": \"An Agent\", \"email\": \"agent@yourcompany.com\", \"phone\": \"+4511223344\", \"roles\": [ \"Admin\", \"TeamLead\", \"SystemAdmin\", \"Agent\" ] } } }"},{"deliveryDetail":{"deliveryTimestamp":"2023-09-15T08:00:00.000Z","success":true,"responseCode":200,"responseText":"OK"},"payload":"{ \"event_id\": \"9963e0c6-fe64-4105-bf71-14ae0c123hh5\", \"event_fqn\": \"CONVERSATION_NOTE_ADDED\", \"event_version\": \"1\", \"event_timestamp\": \"2023-09-15T08:00:00.000Z\", \"organization\": { \"id\": \"g1b15dq2-bba8-48a8-a92e-852014a166r9\", \"name\": \"Your Org Name\" }, \"data\": { \"conversation\": { \"csid\": 1234, \"channel\": \"WIDGET_CHAT\", \"status\": \"OPEN\", \"direction\": \"INBOUND\", \"queue\": { \"id\": \"b5b10483-7d28-4dea-bf8d-0d88cc3bd7cc\", \"name\": \"Your Queue\" }, \"contact_point\": \"Your Contact Point\", \"requester\": { \"id\": \"ec4a2b65-0403-42b3-b054-8998325fd8ac\", \"name\": \"Test Requester\", \"email\": \"test@example.com\", \"phone\": null, \"roles\": [ \"Enduser\" ] }, \"assignee\": { \"id\": \"cccb8520-e24f-43bf-8344-49d07665d854\", \"name\": \"An Agent\", \"email\": \"agent@yourcompany.com\", \"phone\": \"+4511223344\", \"roles\": [ \"Admin\", \"TeamLead\", \"SystemAdmin\", \"Agent\" ] }, \"subject\": null, \"tags\": [], \"created_at\": \"2023-09-01T12:00:00.000Z\" }, \"note_id\": \"ac951357-5189-4707-add7-616af55698q7\", \"text\": \"First Note\", \"created_at\": \"2023-09-15T08:00:00.000Z\", \"author\": { \"id\": \"cccb8520-e24f-43bf-8344-49d07665d854\", \"name\": \"An Agent\", \"email\": \"agent@yourcompany.com\", \"phone\": \"+4511223344\", \"roles\": [ \"Admin\", \"TeamLead\", \"SystemAdmin\", \"Agent\" ] } } }"}]}}}},"400":{"description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/templates":{"get":{"tags":["Templates"],"summary":"List templates","description":"Lists all templates belonging to an organization.","operationId":"getTemplates","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter by template type","required":false,"schema":{"type":"string","enum":["EmailAutoReply","QuickResponse"]},"example":"QuickResponse"}],"responses":{"200":{"description":"The list of templates in an organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTemplatesOutput"},"example":{"data":[{"id":"f8e20c27-c63c-4877-b95a-09a367660578","name":"30-days return policyy","content":"Hi {{requester_firstname}},\n\nWhen you shop at Company Name we offer a 30 day no-hassle return policy\n\nYou're welcome!!!!\n\n{{csid}}\n\nregards,\n{{agent_firstname}}","createdBy":"80466b45-2de8-4693-a62e-6ebacaac58d0","createdAt":"2017-09-27T14:27:54.371+00:00","lastEditedBy":"5e8e95e3-60d3-4350-b6d7-b750728af080","lastEditedAt":"2024-06-21T11:43:29.877+00:00","translations":[{"locale":"da","content":"Hej {{requester_firstname}},\n\nNår du handler hos Company Name, tilbyder vi en 30 dages returpolitik uden besvær\n\nDu er velkommen!!!!\n\n{{csid}}\n\nvenlig hilsen,\n{{agent_firstname}}","isDeactivated":false,"subject":"30-dages returpolitik hos Company Name csid:{{csid}} agent_firstname:{{agent_firstname}} requester_firstname:{{requester_firstname}}"},{"locale":"de-AT","content":"Hallo {{requester_firstname}},\n\nWenn Sie bei Company Name einkaufen, bieten wir Ihnen ein 30-tägiges Rückgaberecht ohne Aufwand\n\nWillkommen!!!!\n\n{{csid}}\n\nmit freundlichen Grüßen,\n{{agent_firstname}}","isDeactivated":false,"subject":"30-Tage-Rückgaberecht bei Company Name csid:{{csid}} agent_firstname:{{agent_firstname}} requester_firstname:{{requester_firstname}}"},{"locale":"uz-Arab-AF","content":"ياخشى {{requester_firstname}},\\n\\nسزنىڭ دوكانىمىزدا سودا قلگانىڭىز ئۈچۈن، 30 كۇنلىك قىينىقسىز قايتارىش سىياسىتى تەقدىم قىلامىز\\n\\nخۇش كەپسىز!!!!\\n\\n{{csid}}\\n\\nھۆرمەت بىلەن,\\n{{agent_firstname}}","isDeactivated":false,"subject":"30-روزه قايتارىش سىياسىتى بۇلادى Company Name csid:{{csid}} agent_firstname:{{agent_firstname}} requester_firstname:{{requester_firstname}}"}],"subject":"30-days return policy at Company Name csid:{{csid}} agent_firstname:{{agent_firstname}} requester_firstname:{{requester_firstname}}","_type":"QuickResponse"},{"id":"08ee5fe1-11c8-4365-87c8-70da0ffd6fb4","name":"Welcome message","content":"Hi {{requester_firstname}},\n\nWelcome to Company Name! We're excited to have you as a customer\n\n{{csid}}\n\nBest,\n{{agent_firstname}}","createdBy":"80466b45-2de8-4693-a62e-6ebacaac58d0","createdAt":"2017-09-27T14:27:54.371+00:00","_type":"EmailAutoReply"}]}}}},"400":{"description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/templates/{templateId}":{"delete":{"tags":["Templates"],"summary":"Delete template","description":"Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible.","operationId":"deleteTemplatesTemplateid","parameters":[{"name":"templateId","in":"path","description":"The template id","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"The template was successfully deleted"},"400":{"description":"Invalid value for: path parameter templateId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["settings.template"]}]}},"/beta/business-hours/schedules":{"get":{"tags":["Business Hours"],"summary":"List business hours schedules","description":"List business hours schedules in an organization with pagination.","operationId":"getBusiness-hoursSchedules","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBusinessHoursSchedulesOutput"},"example":{"data":{"schedules":[{"name":"Schedule 1","id":"b462107a-0a67-19f6-bfc0-207012e0190f"},{"name":"Schedule 2","id":"f462107a-0a57-66f6-dac0-207012e01255"},{"name":"Schedule 3","id":"e462107a-0f23-44f6-48b3-207012e0184e"}]}}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/business-hours/schedules/{scheduleId}/definition":{"get":{"tags":["Business Hours"],"summary":"Get a business hours schedule definition.","description":"Get a business hours schedule definition in an organization by providing its ID.","operationId":"getBusiness-hoursSchedulesScheduleidDefinition","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBusinessHoursScheduleDefinitionOutput"},"example":{"data":{"schedule":{"id":"a0d559bf-cdf8-4088-841d-f3807b93272e","name":"Schedule 1","timezone":"Europe/Copenhagen","businessHours":[{"name":"Monday","dayOfWeek":1,"businessHourType":"Regular","status":"Open","intervals":[{"startTime":"08:00","endTime":"16:00"}],"startDate":"2026-01-05"},{"name":"Tuesday","dayOfWeek":2,"businessHourType":"Regular","status":"Open","intervals":[{"startTime":"08:00","endTime":"16:00"}],"startDate":"2026-01-06"}],"exceptions":[{"name":"New Year","businessHourType":"Holiday","status":"Closed","intervals":[],"recurring":{"dayOfMonth":1,"monthOfYear":1},"startDate":"2026-01-01"}]}}}}}},"400":{"description":"Invalid value for: path parameter scheduleId, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/business-hours/schedules/{scheduleId}/upcoming":{"get":{"tags":["Business Hours"],"summary":"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.","operationId":"getBusiness-hoursSchedulesScheduleidUpcoming","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"days","in":"query","description":"Number of upcoming days to include in the response. Must be between 1 and 90.","required":false,"schema":{"default":7,"type":"integer","format":"int32","minimum":1,"maximum":90}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUpcomingBusinessHoursScheduleOutput"},"examples":{"Days open with a single interval":{"value":{"data":{"schedule":{"id":"a0d559bf-cdf8-4088-841d-f3807b93272e","name":"Schedule 1","timezone":"Europe/Copenhagen","businessHours":[{"name":"Monday","dayOfWeek":1,"businessHourType":"Regular","status":"Open","intervals":[{"startTime":"08:00","endTime":"16:00"}],"startDate":"2026-01-05","nextDate":"2026-05-25"},{"name":"Tuesday","dayOfWeek":2,"businessHourType":"Regular","status":"Open","intervals":[{"startTime":"08:00","endTime":"16:00"}],"startDate":"2026-01-06","nextDate":"2026-05-26"}]}}}},"Split hours (closed 12:00-13:00) and an explicitly closed day":{"value":{"data":{"schedule":{"id":"a0d559bf-cdf8-4088-841d-f3807b93272e","name":"Schedule 1","timezone":"Europe/Copenhagen","businessHours":[{"name":"Monday","dayOfWeek":1,"businessHourType":"Regular","status":"Open","intervals":[{"startTime":"08:00","endTime":"12:00"},{"startTime":"13:00","endTime":"17:00"}],"startDate":"2026-01-05","nextDate":"2026-05-25"},{"name":"Sunday","dayOfWeek":7,"businessHourType":"Regular","status":"Closed","intervals":[],"startDate":"2026-01-04","nextDate":"2026-05-31"}]}}}},"No day in the requested window has configured hours":{"value":{"data":{"schedule":{"id":"a0d559bf-cdf8-4088-841d-f3807b93272e","name":"Schedule 1","timezone":"Europe/Copenhagen","businessHours":[]}}}}}}}},"400":{"description":"Invalid value for: path parameter scheduleId, Invalid value for: query parameter days, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/business-hours/schedules/{scheduleId}/status":{"get":{"tags":["Business Hours"],"summary":"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.","operationId":"getBusiness-hoursSchedulesScheduleidStatus","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"}},{"name":"timestamp","in":"query","description":"An optional timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z' to check if the business is open at a specific time. If not specified, the current time is used.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The business hours status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBusinessOpenStatusOutput"},"examples":{"Open, closes at 17:00":{"value":{"data":{"isOpen":true,"timestamp":"2025-01-08T08:31:25Z","closesAt":"2025-01-08T17:00:00Z"}}},"Closed, next opening at 09:00":{"value":{"data":{"isOpen":false,"timestamp":"2025-01-08T05:31:25Z","opensAt":"2025-01-08T09:00:00Z"}}},"Closed, no opening within the next year":{"value":{"data":{"isOpen":false,"timestamp":"2025-01-08T05:31:25Z"}}}}}}},"400":{"description":"Invalid value for: query parameter timestamp, Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/knowledge/collections/{collectionId}":{"get":{"tags":["Knowledge"],"summary":"Get collection","description":"Get a knowledge collection by id","operationId":"getKnowledgeCollectionsCollectionid","parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The knowledge collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeCollectionOutput"},"example":{"data":{"id":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419","title":"Test Collection","description":"This is a test collection","internalKbEnabled":true,"restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/knowledge/collections/{collectionId}/catalog":{"get":{"tags":["Knowledge"],"summary":"Get collection catalog","description":"Get collection catalog, including all categories and articles","operationId":"getKnowledgeCollectionsCollectionidCatalog","parameters":[{"name":"collectionId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"language","in":"query","description":"Language in which the article translations will be returned. If not provided, the default language will be used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The knowledge collection catalog","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeCollectionCatalogOutput"},"example":{"data":{"categories":[{"id":"123e4567-e89b-12d3-a456-426614174000","title":{"languageId":"en","title":"Getting Started"},"categories":[{"id":"123e4567-e89b-12d3-a456-426614174000","title":{"languageId":"en","title":"Getting Started"},"categories":[],"articles":[{"id":"5f2640d8-631c-4472-8d48-3de0cfd21cd0","title":{"languageId":"en","title":"Getting Started"}}]}],"articles":[{"id":"5f2640d8-631c-4472-8d48-3de0cfd21cd0","title":{"languageId":"en","title":"Getting Started"}}]}],"articles":[{"id":"5f2640d8-631c-4472-8d48-3de0cfd21cd0","title":{"languageId":"en","title":"Getting Started"}}]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/knowledge/categories/{categoryId}":{"get":{"tags":["Knowledge"],"summary":"Get category","description":"Get a knowledge category by id","operationId":"getKnowledgeCategoriesCategoryid","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"language","in":"query","description":"Language in which the article translations will be returned. If not provided, the default language will be used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeCategoryOutput"},"example":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","title":{"languageId":"en","title":"Getting Started"},"isDefaultLocation":true,"isLocked":false,"restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]},"parentCategory":"222e4567-e89b-12d3-a456-426614174111","parentCollections":["78dfb531-2e1e-4ffc-bd18-fdad68cd2419"]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/knowledge/categories/{categoryId}/translations":{"get":{"tags":["Knowledge"],"summary":"Get category translations","description":"Get the knowledge category translations","operationId":"getKnowledgeCategoriesCategoryidTranslations","parameters":[{"name":"categoryId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The category translations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeCategoryTranslationsOutput"},"example":{"data":{"titles":[{"languageId":"en","title":"Getting Started"}]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/knowledge/articles/{articleId}":{"get":{"tags":["Knowledge"],"summary":"Get article","description":"Get a knowledge article by id","operationId":"getKnowledgeArticlesArticleid","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"language","in":"query","description":"Language in which the article translations will be returned. If not provided, the default language will be used.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The knowledge article","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeArticleOutput"},"example":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","isDefaultLocation":true,"translation":{"draft":{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"},"published":{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"}},"tags":["f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"],"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","indexedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000","ownedBy":"123e4567-e89b-12d3-a456-426614174000","indexedBy":"123e4567-e89b-12d3-a456-426614174000","restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]},"parentCategory":"123e4567-e89b-12d3-a456-426614174000","parentCollections":["78dfb531-2e1e-4ffc-bd18-fdad68cd2419"]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"delete":{"tags":["Knowledge"],"summary":"Delete article","description":"Delete a knowledge article","operationId":"deleteKnowledgeArticlesArticleid","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]},"patch":{"tags":["Knowledge"],"summary":"Update article","description":"Update a knowledge article","operationId":"patchKnowledgeArticlesArticleid","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The knowledge article fields to update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKnowledgeArticleInput"},"example":{"ownedBy":"123e4567-e89b-12d3-a456-426614174000","tags":{"add":["tag-id-1"]},"preRelease":false}}},"required":true},"responses":{"200":{"description":"The updated knowledge article","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKnowledgeArticleOutput"},"example":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","isDefaultLocation":true,"translation":{"draft":{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"},"published":{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"}},"tags":["f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"],"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","indexedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000","ownedBy":"123e4567-e89b-12d3-a456-426614174000","indexedBy":"123e4567-e89b-12d3-a456-426614174000","restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]},"parentCategory":"123e4567-e89b-12d3-a456-426614174000","parentCollections":["78dfb531-2e1e-4ffc-bd18-fdad68cd2419"]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/translations":{"get":{"tags":["Knowledge"],"summary":"Get article translations","description":"Get a knowledge article translations","operationId":"getKnowledgeArticlesArticleidTranslations","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The article translations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeArticleTranslationsOutput"},"example":{"data":{"translations":{"draft":[{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"}],"published":[{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"}]}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"patch":{"tags":["Knowledge"],"summary":"Update article translations","description":"Update translations for a knowledge article. Supports partial success.","operationId":"patchKnowledgeArticlesArticleidTranslations","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"The translations to update for the article","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTranslationsInput"},"example":{"translations":[{"languageId":"en","title":"My Article","content":"<p>Hello world</p>"}]}}},"required":true},"responses":{"200":{"description":"The updated translations, with partial errors if any","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTranslationsOutput"},"example":{"data":[{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles":{"post":{"tags":["Knowledge"],"summary":"Create article","description":"Create a knowledge article","operationId":"postKnowledgeArticles","requestBody":{"description":"The knowledge article to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeArticleInput"},"example":{"translations":[{"languageId":"en","title":"My Article","content":"<p>Content</p>"}],"parentId":"123e4567-e89b-12d3-a456-426614174000","tags":["f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"],"preRelease":false}}},"required":true},"responses":{"200":{"description":"The created knowledge article","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeArticleOutput"},"example":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","isDefaultLocation":true,"translation":{"draft":{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"},"published":{"language":"en","title":"Getting Started","isIndexedVersion":true,"contents":{"html":"<p>HTML content</p>","plaintext":"plaintext content"},"availableAt":{"helpCenterLinks":[{"id":"112b5b9c-926a-4338-8963-0dc73d29dec7","name":"Dixa Help Center","url":"https://help.dixa.com"}]},"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000"}},"tags":["f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"],"createdAt":"2021-12-01T12:46:36.581Z[GMT]","updatedAt":"2021-12-01T12:46:36.581Z[GMT]","indexedAt":"2021-12-01T12:46:36.581Z[GMT]","createdBy":"123e4567-e89b-12d3-a456-426614174000","updatedBy":"123e4567-e89b-12d3-a456-426614174000","ownedBy":"123e4567-e89b-12d3-a456-426614174000","indexedBy":"123e4567-e89b-12d3-a456-426614174000","restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]},"parentCategory":"123e4567-e89b-12d3-a456-426614174000","parentCollections":["78dfb531-2e1e-4ffc-bd18-fdad68cd2419"]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/categories":{"post":{"tags":["Knowledge"],"summary":"Create category","description":"Create a knowledge category. Every category belongs to a collection: pass a collection ID as `parentId` to create a top-level category, or a category ID to create a subcategory","operationId":"postKnowledgeCategories","requestBody":{"description":"The knowledge category to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeCategoryInput"},"example":{"translations":[{"languageId":"en","title":"Getting Started"}],"parentId":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}}},"required":true},"responses":{"200":{"description":"The created knowledge category","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeCategoryOutput"},"example":{"data":{"id":"123e4567-e89b-12d3-a456-426614174000","title":{"languageId":"en","title":"Getting Started"},"isDefaultLocation":true,"isLocked":false,"restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]},"parentCategory":"222e4567-e89b-12d3-a456-426614174111","parentCollections":["78dfb531-2e1e-4ffc-bd18-fdad68cd2419"]}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/collections":{"get":{"tags":["Knowledge"],"summary":"List collections","description":"Paginated list knowledge collections","operationId":"getKnowledgeCollections","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of knowledge collections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListKnowledgeCollectionsOutput"},"example":{"data":[{"id":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419","title":"Test Collection","description":"This is a test collection","internalKbEnabled":true,"restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]}}]}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["Knowledge"],"summary":"Create collection","description":"Create a knowledge collection","operationId":"postKnowledgeCollections","requestBody":{"description":"The knowledge collection to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeCollectionInput"},"example":{"title":"Test Collection","description":"This is a test collection","internalKbEnabled":true}}},"required":true},"responses":{"200":{"description":"The created knowledge collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeCollectionOutput"},"example":{"data":{"id":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419","title":"Test Collection","description":"This is a test collection","internalKbEnabled":true,"restrictions":{"isRestricted":true,"inheritedRestrictions":[{"fromCollection":"78dfb531-2e1e-4ffc-bd18-fdad68cd2419"}]}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.collections:w"]}]}},"/beta/knowledge/articles/{articleId}/translations/{languageId}/publish":{"post":{"tags":["Knowledge"],"summary":"Publish translation","description":"Publish a specific translation for search","operationId":"postKnowledgeArticlesArticleidTranslationsLanguageidPublish","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"languageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/translations/{languageId}/unpublish":{"post":{"tags":["Knowledge"],"summary":"Unpublish translation","description":"Mark a specific translation as unpublished","operationId":"postKnowledgeArticlesArticleidTranslationsLanguageidUnpublish","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"languageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/translations/{languageId}":{"delete":{"tags":["Knowledge"],"summary":"Delete article translation","description":"Delete all versions of a knowledge article translation","operationId":"deleteKnowledgeArticlesArticleidTranslationsLanguageid","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"languageId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/publish":{"post":{"tags":["Knowledge"],"summary":"Publish article","description":"Publish a new version of all translations for a knowledge article","operationId":"postKnowledgeArticlesArticleidPublish","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/unpublish":{"post":{"tags":["Knowledge"],"summary":"Unpublish article","description":"Remove all translations of a knowledge article from search","operationId":"postKnowledgeArticlesArticleidUnpublish","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/parent/{parentId}":{"patch":{"tags":["Knowledge"],"summary":"Move article","description":"Move a knowledge article to a new parent","operationId":"patchKnowledgeArticlesArticleidParentParentid","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"parentId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/{articleId}/parent":{"delete":{"tags":["Knowledge"],"summary":"Remove article parent","description":"Remove a parent from a knowledge article","operationId":"deleteKnowledgeArticlesArticleidParent","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":""},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/knowledge/articles/attachments":{"post":{"tags":["Knowledge"],"summary":"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.","operationId":"postKnowledgeArticlesAttachments","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadAttachmentsInput"}}},"required":true},"responses":{"200":{"description":"The uploaded attachments, with partial errors if any","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadAttachmentsOutput"},"examples":{"All succeeded":{"summary":"Every uploaded file was accepted","value":{"data":[{"originalFilename":"logo.png","url":"https://cdn.example.com/images/org-id/uuid.png"},{"originalFilename":"banner.jpg","url":"https://cdn.example.com/images/org-id/uuid2.jpg"}],"partialErrors":[]}},"Partial success":{"summary":"Some files succeeded; others failed validation (400) or upload (500)","value":{"data":[{"originalFilename":"logo.png","url":"https://cdn.example.com/images/org-id/uuid.png"}],"partialErrors":[{"originalFilename":"note.txt","message":"Unsupported MIME type 'text/plain'. Allowed: image/gif, image/jpeg, image/png, image/webp","code":400},{"originalFilename":"huge.png","message":"File exceeds 4 MB size limit","code":400},{"originalFilename":"hero.png","message":"Upload failed due to unexpected error","code":500}]}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}},"security":[{"ApiKeyAuth":["knowledge.content:w"]}]}},"/beta/organization":{"get":{"tags":["Organization"],"summary":"Get organization details","description":"Retrieves information about the organization associated with the provided API token","operationId":"getOrganization","responses":{"200":{"description":"The organization details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationOutput"},"example":{"data":{"id":"e9609fa9-efff-4fdc-a7ef-dd335f33c5f6","name":"Example Organization","subdomain":"example-org","status":"Active"}}}}},"400":{"description":"Invalid value extracted from request context","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Invalid value in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/commerce-events":{"post":{"tags":["Commerce Events"],"summary":"Submit commerce event","description":"Submit a commerce event for a user (e.g. order lifecycle events for conversation routing, sales attribution, and analytics).","operationId":"postCommerce-events","requestBody":{"description":"The commerce event to submit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommerceEvent"},"example":{"eventId":"evt_001","eventTimestamp":"2026-05-08T14:32:11Z","user":{"userId":"04a4db4f-cd01-41e2-88cf-32c4b6079f33","_type":"ById"},"payload":{"orderId":"ORD-9981","total":{"amount":8950,"currency":"EUR"},"lineItems":[{"label":"Leather Derby Shoes","reference":"SHOE-42-BLK","quantity":1,"amount":{"amount":8950,"currency":"EUR"}}],"_type":"OrderCreated"}}}},"required":true},"responses":{"202":{"description":"Event accepted"},"400":{"description":"Invalid value for: body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/whatsapp/templates/{templateId}":{"get":{"tags":["WhatsApp Templates"],"summary":"Get WhatsApp template","description":"Get a WhatsApp template by id with template's category and approval status.","operationId":"getWhatsappTemplatesTemplateid","parameters":[{"name":"templateId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"The WhatsApp template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWhatsappTemplateOutput"},"example":{"data":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"order_confirmation","language":"en","createdAt":"2026-01-01T00:00:00Z","category":"UTILITY","approvalStatus":"approved","body":"Your order {{1}} has been confirmed.","variables":{"1":"12345"}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}},"/beta/whatsapp/templates":{"get":{"tags":["WhatsApp Templates"],"summary":"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.","operationId":"getWhatsappTemplates","parameters":[{"name":"pageLimit","in":"query","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"pageKey","in":"query","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"The list of WhatsApp templates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWhatsappTemplatesOutput"},"example":{"data":[{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"order_confirmation","language":"en","createdAt":"2026-01-01T00:00:00Z"},{"id":"517eedd9-bf71-4a84-bd95-2dd21360de3f","name":"delivery_info","language":"en","createdAt":"2026-01-01T00:00:00Z"}],"meta":{"next":"/beta/whatsapp/templates?pageKey=a2V5c2V0UGFnZUtleT1iMlptYzJWMFBUVXcmcGFnZUxpbWl0PTUwJmRpcj1mb3J3YXJk"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}},"post":{"tags":["WhatsApp Templates"],"summary":"Create WhatsApp template","description":"Create a new WhatsApp template. The template body is limited to 1024 characters.","operationId":"postWhatsappTemplates","requestBody":{"description":"The WhatsApp template to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTemplateInput"},"examples":{"Text template":{"summary":"Text template","value":{"name":"order_confirmation","language":"en","templateType":{"body":"Your order {{1}} has been confirmed.","_type":"Text"},"category":"UTILITY","variables":{"1":"12345"}}},"Text template without variables":{"summary":"Text template without variables","value":{"name":"office_closed","language":"en","templateType":{"body":"Our office is closed today.","_type":"Text"},"category":"UTILITY"}},"Media template":{"summary":"Media template","value":{"name":"shipping_update","language":"en","templateType":{"body":"Your package {{1}} has shipped and will arrive on {{2}}.","mediaUrl":"https://example.com/brand-logo.jpg","_type":"Media"},"category":"MARKETING","variables":{"1":"PKG-9876","2":"2026-08-01"}}}}}},"required":true},"responses":{"201":{"description":"The created WhatsApp template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWhatsappTemplateOutput"},"example":{"data":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequest"},"example":{"message":"Decoding failure in request"}}}},"404":{"description":"An entity in this request could not be found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"},"example":{"message":"The requested resource could not be found"}}}},"500":{"description":"Internal failure during request processing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"},"example":{"message":"There was an internal server error while processing the request"}}}}}}}},"components":{"schemas":{"ActivityLogAttribute":{"title":"ActivityLogAttribute","oneOf":[{"$ref":"#/components/schemas/ConversationAssignedAttribute"},{"$ref":"#/components/schemas/ConversationAutoReplySentAttribute"},{"$ref":"#/components/schemas/ConversationChannelChangedAttribute"},{"$ref":"#/components/schemas/ConversationClaimedAttribute"},{"$ref":"#/components/schemas/ConversationCreatedAttribute"},{"$ref":"#/components/schemas/ConversationCustomAttributesUpdatedAttribute"},{"$ref":"#/components/schemas/ConversationEndUserReplacedAttribute"},{"$ref":"#/components/schemas/ConversationLanguageUpdatedAttribute"},{"$ref":"#/components/schemas/ConversationLinkedAttribute"},{"$ref":"#/components/schemas/ConversationOfferedAttribute"},{"$ref":"#/components/schemas/ConversationRatedAttribute"},{"$ref":"#/components/schemas/ConversationRatingOfferedAttribute"},{"$ref":"#/components/schemas/ConversationRatingScheduledAttribute"},{"$ref":"#/components/schemas/ConversationReservedAttribute"},{"$ref":"#/components/schemas/ConversationResolvedStateToggledAttribute"},{"$ref":"#/components/schemas/ConversationSubjectUpdatedAttribute"},{"$ref":"#/components/schemas/ConversationTranscriptionEndedAttribute"},{"$ref":"#/components/schemas/ConversationTransferredAttribute"},{"$ref":"#/components/schemas/ConversationUnassignedAttribute"},{"$ref":"#/components/schemas/MessageAddedAttribute"},{"$ref":"#/components/schemas/MessageRedactedAttribute"},{"$ref":"#/components/schemas/NoteAddedAttribute"},{"$ref":"#/components/schemas/TagAddedAttribute"},{"$ref":"#/components/schemas/TagRemovedAttribute"}]},"ActivityLogEntry":{"title":"ActivityLogEntry","type":"object","required":["id","conversationId","activityTimestamp","activityType","_type"],"properties":{"id":{"type":"string","format":"uuid"},"conversationId":{"type":"integer","format":"int32"},"activityTimestamp":{"type":"string","format":"date-time"},"activityType":{"$ref":"#/components/schemas/DeprecatedActivityLogType"},"_type":{"description":"values: [ConversationRatingScheduled, ConversationPending, ConversationRatingUnscheduled, ConversationOfferRejected, ConversationEndUserReplaced, NoteAdded, FollowupExpired, ConversationRated, TagAdded, ConversationRatingNotOffered, ConversationOfferTimeout, ConversationChannelChanged, ConversationOfferAccepted, MessageAddedByCustomer, ConversationCreatedByCustomer, ConversationCreatedByAgent, ConversationUnlinkedToParent, TransferFailed, TransferSuccessful, ConversationTranscriptionEnded, ConversationOffered, ConversationUnassigned, ConversationMessageRedacted, TagRemoved, TransferInitiated, ConversationResolvedStateToggled, ConversationClaimed, ConversationReopened, ConversationClosed, ConversationLanguageUpdated, FollowupAdded, ConversationCustomAttributesUpdated, ConversationLinkedToParent, ConversationLinkedFromChild, ConversationAutoreplySent, ConversationReserved, ConversationAssigned, ConversationRatingOffered, ConversationUnlinkedFromChild, ConversationTranscriptionStarted, ConversationRatingCancelled, MessageAddedByAgent, FollowupRemoved]","type":"string"},"author":{"$ref":"#/components/schemas/ActivityLogUser"},"attributes":{"$ref":"#/components/schemas/ActivityLogAttribute"}}},"ActivityLogUser":{"title":"ActivityLogUser","type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}},"Ada":{"title":"Ada","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":"The ID of the Dixa user associated with the AI agent, used as `authorId` of a message","type":"string"}}},"Agent":{"title":"Agent","type":"object","required":["id","createdAt","displayName","email"],"properties":{"id":{"description":"Unique identifier for the agent","type":"string","format":"uuid"},"createdAt":{"description":"Time when the agent was created","type":"string","format":"date-time"},"displayName":{"description":"The agent's display name","type":"string"},"email":{"description":"The agent's primary email address","type":"string"},"avatarUrl":{"description":"The url from which to load the agent's avatar","type":"string"},"phoneNumber":{"description":"The agent's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The agent's first name","type":"string"},"lastName":{"description":"The agent's last name","type":"string"},"middleNames":{"description":"The agent's middle names","type":"array","items":{"type":"string"}},"roles":{"description":"The agent's roles","type":"array","uniqueItems":true,"items":{"type":"string"}}}},"AgentId":{"title":"AgentId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldCanHaveSingleValueOrBeEmptyOperator"}}},"AgentMetricDataRequest":{"title":"AgentMetricDataRequest","description":"An agent metric query","type":"object","required":["primaryFilter","timezone"],"properties":{"primaryFilter":{"$ref":"#/components/schemas/AgentPrimaryFilter"},"filters":{"description":"The filters to apply. All filters must match","type":"array","items":{"$ref":"#/components/schemas/SecondaryFilter"}},"timezone":{"description":"The timezone presets and days are evaluated in, such as `Europe/Copenhagen`","type":"string"}}},"AgentOutput":{"title":"AgentOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Agent"}}},"AgentPresenceDurationValue":{"title":"AgentPresenceDurationValue","type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/PresenceDuration"}},"description":{"type":"string"}}},"AgentPrimaryFilter":{"title":"AgentPrimaryFilter","description":"The period to query","type":"object","required":["period"],"properties":{"period":{"$ref":"#/components/schemas/Period"}}},"AgentRecordDataRequest":{"title":"AgentRecordDataRequest","description":"An agent record query","type":"object","required":["primaryFilter","timezone"],"properties":{"primaryFilter":{"$ref":"#/components/schemas/AgentPrimaryFilter"},"filters":{"description":"The filters to apply. All filters must match","type":"array","items":{"$ref":"#/components/schemas/SecondaryFilter"}},"timezone":{"description":"The timezone presets and days are evaluated in, such as `Europe/Copenhagen`","type":"string"},"pagination":{"$ref":"#/components/schemas/PageRequest"},"includeLabels":{"description":"Whether references include a `label`. Defaults to true","type":"boolean"}}},"AgentTeamsOutput":{"title":"AgentTeamsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}},"AgentsToTeamInput":{"title":"AgentsToTeamInput","type":"object","properties":{"agentIds":{"type":"array","items":{"type":"string","format":"uuid"}}}},"AggregateMetadata":{"title":"AggregateMetadata","type":"object","required":["measure"],"properties":{"measure":{"description":"values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]","type":"string"},"description":{"type":"string"}}},"AggregateValue":{"title":"AggregateValue","oneOf":[{"$ref":"#/components/schemas/AgentPresenceDurationValue"},{"$ref":"#/components/schemas/DoubleAggregateValue"},{"$ref":"#/components/schemas/LongAggregateValue"}]},"AiAgent":{"title":"AiAgent","oneOf":[{"$ref":"#/components/schemas/Ada"},{"$ref":"#/components/schemas/Digitalgenius"},{"$ref":"#/components/schemas/Genericapimessaging"},{"$ref":"#/components/schemas/Kindly"},{"$ref":"#/components/schemas/MimAutomation"},{"$ref":"#/components/schemas/MimSupport"}]},"AiAgentMetricDataRequest":{"title":"AiAgentMetricDataRequest","description":"An AI agent metric query","type":"object","required":["primaryFilter","timezone"],"properties":{"primaryFilter":{"$ref":"#/components/schemas/AiAgentPrimaryFilter"},"filters":{"description":"The filters to apply. All filters must match","type":"array","items":{"$ref":"#/components/schemas/SecondaryFilter"}},"timezone":{"description":"The timezone presets and days are evaluated in, such as `Europe/Copenhagen`","type":"string"}}},"AiAgentPrimaryFilter":{"title":"AiAgentPrimaryFilter","description":"The period to query","type":"object","required":["period"],"properties":{"period":{"$ref":"#/components/schemas/Period"}}},"AiAgentRecordDataRequest":{"title":"AiAgentRecordDataRequest","description":"An AI agent record query","type":"object","required":["primaryFilter","timezone"],"properties":{"primaryFilter":{"$ref":"#/components/schemas/AiAgentPrimaryFilter"},"filters":{"description":"The filters to apply. All filters must match","type":"array","items":{"$ref":"#/components/schemas/SecondaryFilter"}},"timezone":{"description":"The timezone presets and days are evaluated in, such as `Europe/Copenhagen`","type":"string"},"pagination":{"$ref":"#/components/schemas/PageRequest"},"includeLabels":{"description":"Whether references include a `label`. Defaults to true","type":"boolean"}}},"AnonymizationRequestStatus":{"title":"AnonymizationRequestStatus","type":"object","required":["id","entityType","_type","initiatedAt","targetEntityId","requestedBy"],"properties":{"id":{"type":"string","format":"uuid"},"entityType":{"$ref":"#/components/schemas/DeprecatedAnonymizationType"},"_type":{"description":"values: [Conversation, Message, User]","type":"string"},"initiatedAt":{"type":"string","format":"date-time"},"targetEntityId":{"type":"string"},"requestedBy":{"type":"string","format":"uuid"},"processedAt":{"type":"string","format":"date-time"}}},"AnonymizeEntityInput":{"title":"AnonymizeEntityInput","type":"object","required":["entityId"],"properties":{"entityId":{"type":"string"},"entityType":{"$ref":"#/components/schemas/DeprecatedAnonymizationType"},"forceAnonymization":{"type":"boolean"},"_type":{"description":"values: [Conversation, Message, User]","type":"string"}}},"AnonymizeEntityOutput":{"title":"AnonymizeEntityOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AnonymizationRequestStatus"}}},"AnonymizedConversation":{"title":"AnonymizedConversation","type":"object","required":["id","requesterId","channel","createdAt","anonymizedAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"anonymizedAt":{"type":"string","format":"date-time"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"Article":{"title":"Article","type":"object","required":["id","createdAt","updatedAt","restrictions"],"properties":{"id":{"type":"string"},"isDefaultLocation":{"type":"boolean"},"translation":{"$ref":"#/components/schemas/Translation1"},"tags":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"indexedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"},"ownedBy":{"type":"string"},"indexedBy":{"type":"string"},"restrictions":{"$ref":"#/components/schemas/Restrictions"},"parentCategory":{"type":"string"},"parentCollections":{"type":"array","items":{"type":"string"}}}},"ArticleCatalogItem":{"title":"ArticleCatalogItem","type":"object","required":["id"],"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/TranslationTitle"}}},"ArticleContent":{"title":"ArticleContent","type":"object","required":["html","plaintext"],"properties":{"html":{"type":"string"},"plaintext":{"type":"string"}}},"ArticleTranslation":{"title":"ArticleTranslation","type":"object","required":["language","title","isIndexedVersion","contents","availableAt","createdAt","updatedAt"],"properties":{"language":{"type":"string"},"title":{"type":"string"},"isIndexedVersion":{"type":"boolean"},"contents":{"$ref":"#/components/schemas/ArticleContent"},"availableAt":{"$ref":"#/components/schemas/AvailableAt"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedBy":{"type":"string"}}},"ArticleTranslations":{"title":"ArticleTranslations","type":"object","required":["translations"],"properties":{"translations":{"$ref":"#/components/schemas/TranslationList"}}},"AssignedDate":{"title":"AssignedDate","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}},"Assignment":{"title":"Assignment","type":"object","required":["agentId","assignedAt"],"properties":{"agentId":{"type":"string","format":"uuid"},"assignedAt":{"type":"string","format":"date-time"}}},"AttachmentError":{"title":"AttachmentError","type":"object","required":["originalFilename","message","code"],"properties":{"originalFilename":{"description":"Original filename of the failed file","type":"string"},"message":{"description":"Error message describing the failure","type":"string"},"code":{"description":"HTTP-style status code: 400 for client-side errors, 500 for server-side errors","type":"integer","format":"int32"}}},"AttachmentResult":{"title":"AttachmentResult","type":"object","required":["originalFilename","url"],"properties":{"originalFilename":{"description":"Original filename of the uploaded file","type":"string"},"url":{"description":"Public URL of the uploaded file","type":"string"}}},"Attachments":{"title":"Attachments","type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/FileMeta"}}}},"Attributes":{"title":"Attributes","oneOf":[{"$ref":"#/components/schemas/CallRecordingAttributes"},{"$ref":"#/components/schemas/ChatAttributes"},{"$ref":"#/components/schemas/ContactFormAttributes"},{"$ref":"#/components/schemas/EmailAttributes"},{"$ref":"#/components/schemas/FacebookMessengerAttributes"},{"$ref":"#/components/schemas/GenericAttributes"},{"$ref":"#/components/schemas/MessengerFormAttributes"},{"$ref":"#/components/schemas/PhoneAttributes"},{"$ref":"#/components/schemas/SmsAttributes"},{"$ref":"#/components/schemas/TranscriptAttributes"},{"$ref":"#/components/schemas/TwitterAttributes"},{"$ref":"#/components/schemas/WhatsAppAttributes"}]},"AvailableAt":{"title":"AvailableAt","type":"object","properties":{"helpCenterLinks":{"type":"array","items":{"$ref":"#/components/schemas/HelpCenterLink"}}}},"BadRequest":{"title":"BadRequest","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"BasicAuth":{"title":"BasicAuth","type":"object","required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}},"Between":{"title":"Between","description":"Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z' ","type":"object","required":["timestampFrom","timestampTo"],"properties":{"timestampFrom":{"type":"string","format":"date-time"},"timestampTo":{"type":"string","format":"date-time"}}},"Between1":{"title":"Between","description":"min and max in milliseconds; for example: '10800000' (3 hours)","type":"object","required":["min","max"],"properties":{"min":{"type":"integer","format":"int64"},"max":{"type":"integer","format":"int64"}}},"BooleanField":{"title":"BooleanField","type":"object","required":["value"],"properties":{"value":{"type":"boolean"}}},"BrowserInfo":{"title":"BrowserInfo","type":"object","required":["name"],"properties":{"name":{"type":"string"},"version":{"type":"string"},"ipAddress":{"type":"string"},"originatingUrl":{"type":"string"}}},"BulkActionFailure_BulkError_Agent":{"title":"BulkActionFailure_BulkError_Agent","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BulkError"}}},"BulkActionFailure_BulkError_EndUser":{"title":"BulkActionFailure_BulkError_EndUser","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BulkError"}}},"BulkActionFailure_BulkError_UUID":{"title":"BulkActionFailure_BulkError_UUID","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BulkError"}}},"BulkActionFailure_ErrorResponse_InternalNoteData":{"title":"BulkActionFailure_ErrorResponse_InternalNoteData","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/ErrorResponse"}}},"BulkActionOutcome_BulkError_Agent":{"title":"BulkActionOutcome_BulkError_Agent","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_BulkError_Agent"},{"$ref":"#/components/schemas/BulkActionSuccess_BulkError_Agent"}]},"BulkActionOutcome_BulkError_EndUser":{"title":"BulkActionOutcome_BulkError_EndUser","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_BulkError_EndUser"},{"$ref":"#/components/schemas/BulkActionSuccess_BulkError_EndUser"}]},"BulkActionOutcome_BulkError_UUID":{"title":"BulkActionOutcome_BulkError_UUID","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_BulkError_UUID"},{"$ref":"#/components/schemas/BulkActionSuccess_BulkError_UUID"}]},"BulkActionOutcome_ErrorResponse_InternalNoteData":{"title":"BulkActionOutcome_ErrorResponse_InternalNoteData","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_ErrorResponse_InternalNoteData"},{"$ref":"#/components/schemas/BulkActionSuccess_ErrorResponse_InternalNoteData"}]},"BulkActionSuccess_BulkError_Agent":{"title":"BulkActionSuccess_BulkError_Agent","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Agent"}}},"BulkActionSuccess_BulkError_EndUser":{"title":"BulkActionSuccess_BulkError_EndUser","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}},"BulkActionSuccess_BulkError_UUID":{"title":"BulkActionSuccess_BulkError_UUID","type":"object","required":["data"],"properties":{"data":{"type":"string","format":"uuid"}}},"BulkActionSuccess_ErrorResponse_InternalNoteData":{"title":"BulkActionSuccess_ErrorResponse_InternalNoteData","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InternalNoteData"}}},"BulkCreateInternalNoteInput":{"title":"BulkCreateInternalNoteInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateInternalNoteInput"}}}},"BulkCreateNoteOutput":{"title":"BulkCreateNoteOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_ErrorResponse_InternalNoteData"}}}},"BulkError":{"title":"BulkError","oneOf":[{"$ref":"#/components/schemas/EmptyPatchSet"},{"$ref":"#/components/schemas/ErrorResponse"},{"$ref":"#/components/schemas/Infrastructure"},{"$ref":"#/components/schemas/Integrity"},{"$ref":"#/components/schemas/InvalidArgument"},{"$ref":"#/components/schemas/NotFound1"},{"$ref":"#/components/schemas/Validation"}]},"BulkPatchAgentInput":{"title":"BulkPatchAgentInput","type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier for the agent","type":"string"},"displayName":{"description":"The agent's display name","type":"string"},"phoneNumber":{"description":"The agent's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The agent's first name","type":"string"},"lastName":{"description":"The agent's last name","type":"string"},"middleNames":{"description":"The agent's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the agent's avatar","type":"string"}}},"BulkPatchEndUserInput":{"title":"BulkPatchEndUserInput","type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"additionalEmails":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"middleNames":{"type":"array","items":{"type":"string"}},"avatarUrl":{"type":"string"},"externalId":{"type":"string"}}},"BulkPatchEndUsersInput":{"title":"BulkPatchEndUsersInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkPatchEndUserInput"}}}},"BulkPatchEndUsersOutput":{"title":"BulkPatchEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_EndUser"}}}},"BulkQueueEndpointInput":{"title":"BulkQueueEndpointInput","type":"object","properties":{"agentIds":{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"}}}},"BulkQueueEndpointOutput":{"title":"BulkQueueEndpointOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_UUID"}}}},"BulkTagConversationInput":{"title":"BulkTagConversationInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TagConversationInput"}}}},"BulkUpdateAgentInput":{"title":"BulkUpdateAgentInput","type":"object","required":["id","displayName"],"properties":{"id":{"description":"Unique identifier for the agent","type":"string"},"displayName":{"description":"The agent's display name","type":"string"},"phoneNumber":{"description":"The agent's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The agent's first name","type":"string"},"lastName":{"description":"The agent's last name","type":"string"},"middleNames":{"description":"The agent's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the agent's avatar","type":"string"}}},"BulkUpdateAgentOutput":{"title":"BulkUpdateAgentOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_Agent"}}}},"BulkUpdateEndUserInput":{"title":"BulkUpdateEndUserInput","type":"object","required":["id","displayName"],"properties":{"id":{"type":"string","format":"uuid"},"displayName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"additionalEmails":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"middleNames":{"type":"array","items":{"type":"string"}},"avatarUrl":{"type":"string"},"externalId":{"type":"string"}}},"BulkUpdateEndUsersInput":{"title":"BulkUpdateEndUsersInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateEndUserInput"}}}},"BulkUpdateEndUsersOutput":{"title":"BulkUpdateEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_EndUser"}}}},"BusinessHour":{"title":"BusinessHour","type":"object","required":["name","businessHourType","status","startDate"],"properties":{"name":{"type":"string"},"dayOfWeek":{"type":"integer","format":"int32"},"businessHourType":{"$ref":"#/components/schemas/BusinessHourType"},"status":{"$ref":"#/components/schemas/BusinessHourStatus1"},"intervals":{"type":"array","items":{"$ref":"#/components/schemas/TimeInterval1"}},"recurring":{"$ref":"#/components/schemas/Recurring1"},"startDate":{"type":"string"},"nextDate":{"type":"string"}}},"BusinessHourException":{"title":"BusinessHourException","type":"object","required":["name","businessHourType","status","startDate"],"properties":{"name":{"type":"string"},"businessHourType":{"$ref":"#/components/schemas/BusinessHourExceptionType"},"status":{"$ref":"#/components/schemas/BusinessHourStatus"},"intervals":{"type":"array","items":{"$ref":"#/components/schemas/TimeInterval"}},"recurring":{"$ref":"#/components/schemas/Recurring"},"startDate":{"type":"string"},"nextDate":{"type":"string"}}},"BusinessHourExceptionType":{"title":"BusinessHourExceptionType","oneOf":[{"$ref":"#/components/schemas/Exception"},{"$ref":"#/components/schemas/Holiday"}]},"BusinessHourRegular":{"title":"BusinessHourRegular","type":"object","required":["name","businessHourType","status","startDate"],"properties":{"name":{"type":"string"},"dayOfWeek":{"type":"integer","format":"int32"},"businessHourType":{"$ref":"#/components/schemas/BusinessHourRegularType"},"status":{"$ref":"#/components/schemas/BusinessHourStatus"},"intervals":{"type":"array","items":{"$ref":"#/components/schemas/TimeInterval"}},"startDate":{"type":"string"}}},"BusinessHourRegularType":{"title":"BusinessHourRegularType","oneOf":[{"$ref":"#/components/schemas/Regular1"}]},"BusinessHourStatus":{"title":"BusinessHourStatus","oneOf":[{"$ref":"#/components/schemas/Closed"},{"$ref":"#/components/schemas/Open"}]},"BusinessHourStatus1":{"title":"BusinessHourStatus","oneOf":[{"$ref":"#/components/schemas/Closed1"},{"$ref":"#/components/schemas/Open1"}]},"BusinessHourType":{"title":"BusinessHourType","oneOf":[{"$ref":"#/components/schemas/Exception1"},{"$ref":"#/components/schemas/Holiday1"},{"$ref":"#/components/schemas/Regular2"}]},"BusinessHoursSchedule":{"title":"BusinessHoursSchedule","type":"object","required":["name","id"],"properties":{"name":{"type":"string"},"id":{"type":"string"}}},"BusinessHoursScheduleDefinition":{"title":"BusinessHoursScheduleDefinition","type":"object","required":["id","name","timezone"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"},"businessHours":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHourRegular"}},"exceptions":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHourException"}}}},"BusinessHoursUpcomingSchedule":{"title":"BusinessHoursUpcomingSchedule","type":"object","required":["id","name","timezone"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"timezone":{"type":"string"},"businessHours":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHour"}}}},"ByContactPoints":{"title":"ByContactPoints","type":"object","required":["displayName"],"properties":{"contactPoints":{"description":"Contact points used to find or create the user; first match wins","type":"array","items":{"$ref":"#/components/schemas/ContactPoint"}},"displayName":{"description":"Display name used when creating a new user; ignored if an existing user is found","type":"string"}}},"ById":{"title":"ById","type":"object","required":["userId"],"properties":{"userId":{"description":"Dixa end-user ID","type":"string"}}},"CallRecordingAttributes":{"title":"CallRecordingAttributes","type":"object","required":["recording"],"properties":{"duration":{"type":"integer","format":"int32"},"recording":{"type":"string"}}},"Callback":{"title":"Callback","type":"object","required":["requesterId","direction","contactEndpointId","queueId"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"direction":{"description":"values: [Inbound, Outbound]","type":"string"},"contactEndpointId":{"type":"string"},"queueId":{"type":"string","format":"uuid"}}},"Category":{"title":"Category","type":"object","required":["id","isLocked","restrictions"],"properties":{"id":{"description":"ID of the category","type":"string"},"title":{"$ref":"#/components/schemas/TranslationTitle","description":"Title of the category in the requested language, or in the default language if no language was requested. Empty if the category has no translation in the requested language"},"isDefaultLocation":{"description":"Whether this is the category's default placement. Always `true`, or empty if the category has no parent","type":"boolean"},"isLocked":{"description":"Whether the category is synced from an Elevio workspace import. Locked categories cannot be modified (deleted, moved or renamed) while the import is active","type":"boolean"},"restrictions":{"$ref":"#/components/schemas/Restrictions","description":"Access restrictions on the category, set directly or inherited from its parents"},"parentCategory":{"description":"ID of the parent category. Empty for a top-level category, whose parent is a collection","type":"string"},"parentCollections":{"description":"IDs of all collections the category belongs to","type":"array","items":{"type":"string"}}}},"CategoryCatalogItem":{"title":"CategoryCatalogItem","type":"object","required":["id"],"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/TranslationTitle"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryCatalogItem"}},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleCatalogItem"}}}},"CategoryTranslationInput":{"title":"CategoryTranslationInput","type":"object","required":["languageId","title"],"properties":{"languageId":{"description":"ISO language code (e.g. en, da, de)","type":"string"},"title":{"description":"Title of the translation","type":"string"}}},"CategoryTranslations":{"title":"CategoryTranslations","type":"object","properties":{"titles":{"type":"array","items":{"$ref":"#/components/schemas/TranslationTitle"}}}},"Channel":{"title":"Channel","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/ChannelOperator"}}},"ChannelAvailability":{"title":"ChannelAvailability","oneOf":[{"$ref":"#/components/schemas/GenericChannel"}]},"ChannelAvailabilityError":{"title":"ChannelAvailabilityError","oneOf":[{"$ref":"#/components/schemas/UnexpectedError"}]},"ChannelAvailabilityOutcome":{"title":"ChannelAvailabilityOutcome","oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/Success"}]},"ChannelOperator":{"title":"ChannelOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf1"},{"$ref":"#/components/schemas/IsOneOf1"}]},"Chat":{"title":"Chat","type":"object","required":["requesterId","widgetId","message"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"widgetId":{"type":"string","format":"uuid"},"message":{"$ref":"#/components/schemas/CreateMessageInput"},"browserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"language":{"type":"string"}}},"ChatAttributes":{"title":"ChatAttributes","type":"object","required":["isAutomated"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"isAutomated":{"type":"boolean"}}},"ChatConversation":{"title":"ChatConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"browserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"language":{"type":"string"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"Checksum":{"title":"Checksum","type":"object","required":["algorithm","hex"],"properties":{"algorithm":{"type":"string"},"hex":{"type":"string"}}},"ClaimConversationInput":{"title":"ClaimConversationInput","type":"object","required":["agentId"],"properties":{"agentId":{"description":"The id of the agent who is claiming the conversation","type":"string","format":"uuid"},"force":{"description":"Set as false to avoid taking over the conversation if it is already assigned to an agent","type":"boolean"}}},"CloseConversationInput":{"title":"CloseConversationInput","type":"object","properties":{"userId":{"description":"An optional agent/admin/AI agent to close the conversation. If not provided, the System User will be used.","type":"string","format":"uuid"}}},"Closed":{"title":"Closed","type":"object"},"Closed1":{"title":"Closed","type":"object"},"ClosedDate":{"title":"ClosedDate","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}},"Closing":{"title":"Closing","description":"Triggers the closing of the conversation","type":"object","required":["closedAt","closedBy"],"properties":{"closedAt":{"type":"string","format":"date-time"},"closedBy":{"type":"string","format":"uuid"}}},"Collection":{"title":"Collection","type":"object","required":["id","title","internalKbEnabled","restrictions"],"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"internalKbEnabled":{"type":"boolean"},"restrictions":{"$ref":"#/components/schemas/Restrictions"}}},"CollectionCatalogItem":{"title":"CollectionCatalogItem","type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryCatalogItem"}},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleCatalogItem"}}}},"CombinedFilters":{"title":"CombinedFilters","type":"object","required":["strategy","conditions"],"properties":{"strategy":{"description":"values: [All, Any]","type":"string"},"conditions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Condition1"}}}},"CommerceEvent":{"title":"CommerceEvent","type":"object","required":["eventId","eventTimestamp","user","payload"],"properties":{"eventId":{"description":"Unique identifier for the event; used for idempotency","type":"string"},"eventTimestamp":{"description":"When the event occurred in the source system, not when Dixa received it","type":"string","format":"date-time"},"user":{"$ref":"#/components/schemas/UserReference","description":"Identifies the user associated with the event."},"author":{"$ref":"#/components/schemas/UserReference","description":"Identifies the author of the action that triggered the event (e.g. a staff member who initiated a refund)."},"origin":{"description":"Sales channel or platform origin (e.g. web, mobile, pos).","type":"string"},"metadata":{"$ref":"#/components/schemas/Map_String","description":"Optional platform-specific key-value pairs for data that does not fit the typed payload."},"payload":{"$ref":"#/components/schemas/CommerceEventPayload"}}},"CommerceEventPayload":{"title":"CommerceEventPayload","description":"Typed event payload. The _type field determines the event variant.","oneOf":[{"$ref":"#/components/schemas/DeliveryAttemptFailed"},{"$ref":"#/components/schemas/OrderCanceled"},{"$ref":"#/components/schemas/OrderCreated"},{"$ref":"#/components/schemas/OrderDelivered"},{"$ref":"#/components/schemas/OrderDrafted"},{"$ref":"#/components/schemas/OrderFulfilled"},{"$ref":"#/components/schemas/RefundCreated"},{"$ref":"#/components/schemas/ReturnReceived"},{"$ref":"#/components/schemas/ReturnRequested"}]},"Condition":{"title":"Condition","type":"object","required":["field"],"properties":{"field":{"$ref":"#/components/schemas/SearchField"}}},"Condition1":{"title":"Condition","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf5"},{"$ref":"#/components/schemas/IsOneOf5"}]},"Conflict":{"title":"Conflict","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ContactEndpoint":{"title":"ContactEndpoint","oneOf":[{"$ref":"#/components/schemas/EmailEndpoint"},{"$ref":"#/components/schemas/TelephonyEndpoint"}]},"ContactForm":{"title":"ContactForm","type":"object","required":["requesterId","emailIntegrationId","subject","message"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"emailIntegrationId":{"type":"string"},"subject":{"type":"string"},"message":{"$ref":"#/components/schemas/CreateMessageInput"},"language":{"type":"string"}}},"ContactFormAttributes":{"title":"ContactFormAttributes","type":"object","required":["isAutoReply"],"properties":{"emailContent":{"$ref":"#/components/schemas/EmailContent"},"from":{"$ref":"#/components/schemas/EmailContact"},"replyDefaultToEmails":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"to":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"isAutoReply":{"type":"boolean"},"inlineImages":{"description":"Files the sender embedded in the message body, such as the images that `emailContent` references. The sending email client decides whether a file is embedded or attached, so a file you would expect in `attachments` can arrive here instead. Read both fields to get every file on the message.","type":"array","items":{"$ref":"#/components/schemas/File"}},"attachments":{"description":"Files the sender attached to the message. Files the sender embedded in the message body are listed in `inlineImages` instead.","type":"array","items":{"$ref":"#/components/schemas/File"}},"deliveryFailureReason":{"type":"string"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"originalContentUrl":{"$ref":"#/components/schemas/File"}}},"ContactFormConversation":{"title":"ContactFormConversation","type":"object","required":["id","requesterId","channel","createdAt","fromEmail"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"fromEmail":{"type":"string"},"toEmail":{"type":"string"},"integrationEmail":{"type":"string"},"language":{"type":"string"},"subject":{"type":"string"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"ContactId":{"title":"ContactId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldHasSingleValueOperator"}}},"ContactPoint":{"title":"ContactPoint","oneOf":[{"$ref":"#/components/schemas/Email1"},{"$ref":"#/components/schemas/Phone"}]},"Content":{"title":"Content","oneOf":[{"$ref":"#/components/schemas/Html"},{"$ref":"#/components/schemas/Markdown"},{"$ref":"#/components/schemas/Text"}]},"Conversation":{"title":"Conversation","oneOf":[{"$ref":"#/components/schemas/AnonymizedConversation"},{"$ref":"#/components/schemas/ChatConversation"},{"$ref":"#/components/schemas/ContactFormConversation"},{"$ref":"#/components/schemas/EmailConversation"},{"$ref":"#/components/schemas/FacebookMessengerConversation"},{"$ref":"#/components/schemas/GenericConversation"},{"$ref":"#/components/schemas/MessengerConversation"},{"$ref":"#/components/schemas/PstnPhoneConversation"},{"$ref":"#/components/schemas/SmsConversation"},{"$ref":"#/components/schemas/TwitterConversation"},{"$ref":"#/components/schemas/WhatsAppConversation"}]},"ConversationAnonymizationType":{"title":"ConversationAnonymizationType","type":"object"},"ConversationAssignedActivityType":{"title":"ConversationAssignedActivityType","type":"object"},"ConversationAssignedAttribute":{"title":"ConversationAssignedAttribute","type":"object","required":["agentId"],"properties":{"agentId":{"type":"string"},"agentName":{"type":"string"}}},"ConversationAutoReplySentAttribute":{"title":"ConversationAutoReplySentAttribute","type":"object","required":["templateName"],"properties":{"templateName":{"type":"string"}}},"ConversationAutoreplySentActivityType":{"title":"ConversationAutoreplySentActivityType","type":"object"},"ConversationChannelChangedAttribute":{"title":"ConversationChannelChangedAttribute","type":"object","required":["channelReference"],"properties":{"channelReference":{"type":"string"}}},"ConversationClaimedActivityType":{"title":"ConversationClaimedActivityType","type":"object"},"ConversationClaimedAttribute":{"title":"ConversationClaimedAttribute","type":"object","properties":{"claimedFromLabel":{"type":"string"},"claimedFromType":{"type":"string"}}},"ConversationClosedActivityType":{"title":"ConversationClosedActivityType","type":"object"},"ConversationCreatedAttribute":{"title":"ConversationCreatedAttribute","type":"object","properties":{"subject":{"type":"string"}}},"ConversationCreatedByAgentActivityType":{"title":"ConversationCreatedByAgentActivityType","type":"object"},"ConversationCreatedByCustomerActivityType":{"title":"ConversationCreatedByCustomerActivityType","type":"object"},"ConversationCustomAttributesUpdatedAttribute":{"title":"ConversationCustomAttributesUpdatedAttribute","type":"object","required":["updatedAttributeValues"],"properties":{"updatedAttributeIds":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"updatedAttributeValues":{"$ref":"#/components/schemas/Map_AttributeValue"}}},"ConversationEndUserReplacedActivityType":{"title":"ConversationEndUserReplacedActivityType","type":"object"},"ConversationEndUserReplacedAttribute":{"title":"ConversationEndUserReplacedAttribute","type":"object","required":["oldUser","newUser"],"properties":{"oldUser":{"$ref":"#/components/schemas/ActivityLogUser"},"newUser":{"$ref":"#/components/schemas/ActivityLogUser"}}},"ConversationFlow":{"title":"ConversationFlow","type":"object","required":["id","name","channel","contactEndpointId"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"contactEndpointId":{"type":"string"}}},"ConversationId":{"title":"ConversationId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldHasSingleValueOperator"}}},"ConversationIdsPrimaryFilter":{"title":"ConversationIdsPrimaryFilter","description":"Query specific conversations, regardless of when they happened","type":"object","properties":{"conversationIds":{"description":"The conversation ids","type":"array","items":{"type":"integer","format":"int64"}}}},"ConversationLanguageUpdatedActivityType":{"title":"ConversationLanguageUpdatedActivityType","type":"object"},"ConversationLanguageUpdatedAttribute":{"title":"ConversationLanguageUpdatedAttribute","type":"object","required":["language"],"properties":{"language":{"type":"string"}}},"ConversationLink":{"title":"ConversationLink","oneOf":[{"$ref":"#/components/schemas/EmailForward"},{"$ref":"#/components/schemas/FollowUp"},{"$ref":"#/components/schemas/SideConversation"}]},"ConversationLinkedAttribute":{"title":"ConversationLinkedAttribute","type":"object","required":["child","parent","linkType"],"properties":{"child":{"type":"integer","format":"int64"},"parent":{"type":"integer","format":"int64"},"linkType":{"type":"string"}}},"ConversationMetricDataRequest":{"title":"ConversationMetricDataRequest","description":"A conversation metric query","type":"object","required":["primaryFilter","timezone"],"properties":{"primaryFilter":{"$ref":"#/components/schemas/ConversationPrimaryFilter"},"filters":{"description":"The filters to apply. All filters must match","type":"array","items":{"$ref":"#/components/schemas/SecondaryFilter"}},"timezone":{"description":"The timezone presets and days are evaluated in, such as `Europe/Copenhagen`","type":"string"}}},"ConversationOfferAcceptedActivityType":{"title":"ConversationOfferAcceptedActivityType","type":"object"},"ConversationOfferRejectedActivityType":{"title":"ConversationOfferRejectedActivityType","type":"object"},"ConversationOfferTimeoutActivityType":{"title":"ConversationOfferTimeoutActivityType","type":"object"},"ConversationOfferedActivityType":{"title":"ConversationOfferedActivityType","type":"object"},"ConversationOfferedAttribute":{"title":"ConversationOfferedAttribute","type":"object","properties":{"agentNames":{"type":"array","items":{"type":"string"}},"queueLabel":{"type":"string"}}},"ConversationPendingActivityType":{"title":"ConversationPendingActivityType","type":"object"},"ConversationPeriodPrimaryFilter":{"title":"ConversationPeriodPrimaryFilter","description":"Query a period","type":"object","required":["period"],"properties":{"period":{"$ref":"#/components/schemas/Period"}}},"ConversationPrimaryFilter":{"title":"ConversationPrimaryFilter","description":"The period or conversations to query, given as either `{\"period\": {...}}` or `{\"conversationIds\": [8123456, 8123481]}`","oneOf":[{"$ref":"#/components/schemas/ConversationIdsPrimaryFilter"},{"$ref":"#/components/schemas/ConversationPeriodPrimaryFilter"}]},"ConversationRatedActivityType":{"title":"ConversationRatedActivityType","type":"object"},"ConversationRatedAttribute":{"title":"ConversationRatedAttribute","type":"object","properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"},"score":{"type":"integer","format":"int32"},"message":{"type":"string"}}},"ConversationRating":{"title":"ConversationRating","type":"object","required":["id","ratingType","conversationChannel","userId","ratingStatus","timestamps"],"properties":{"id":{"type":"string"},"ratingScore":{"type":"integer","format":"int32"},"ratingType":{"description":"values: [Csat, Nps, ThumbsUpOrDown]","type":"string"},"ratingComment":{"type":"string"},"conversationChannel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"agentId":{"type":"string"},"userId":{"type":"string"},"ratingStatus":{"description":"values: [Unscheduled, Offered, Rated, Scheduled, Cancelled]","type":"string"},"language":{"type":"string"},"timestamps":{"$ref":"#/components/schemas/Map_String"}}},"ConversationRatingCancelledActivityType":{"title":"ConversationRatingCancelledActivityType","type":"object"},"ConversationRatingOfferedActivityType":{"title":"ConversationRatingOfferedActivityType","type":"object"},"ConversationRatingOfferedAttribute":{"title":"ConversationRatingOfferedAttribute","type":"object","required":["agent","user"],"properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"},"user":{"$ref":"#/components/schemas/ActivityLogUser"}}},"ConversationRatingScheduledActivityType":{"title":"ConversationRatingScheduledActivityType","type":"object"},"ConversationRatingScheduledAttribute":{"title":"ConversationRatingScheduledAttribute","type":"object","required":["ratingScheduledTime"],"properties":{"ratingScheduledTime":{"type":"string"}}},"ConversationRatingUnscheduledActivityType":{"title":"ConversationRatingUnscheduledActivityType","type":"object"},"ConversationRecordDataRequest":{"title":"ConversationRecordDataRequest","description":"A conversation record query","type":"object","required":["primaryFilter","timezone"],"properties":{"primaryFilter":{"$ref":"#/components/schemas/ConversationPrimaryFilter"},"filters":{"description":"The filters to apply. All filters must match","type":"array","items":{"$ref":"#/components/schemas/SecondaryFilter"}},"timezone":{"description":"The timezone presets and days are evaluated in, such as `Europe/Copenhagen`","type":"string"},"pagination":{"$ref":"#/components/schemas/PageRequest"},"includeLabels":{"description":"Whether references include a `label`. Defaults to true","type":"boolean"}}},"ConversationReopenedActivityType":{"title":"ConversationReopenedActivityType","type":"object"},"ConversationReservedAttribute":{"title":"ConversationReservedAttribute","type":"object","required":["agent","queueId","queueName","reservationType","validUntil"],"properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"},"queueId":{"type":"string"},"queueName":{"type":"string"},"reservationType":{"type":"string"},"validUntil":{"type":"string"}}},"ConversationReservedType":{"title":"ConversationReservedType","type":"object"},"ConversationResolvedStateToggledAttribute":{"title":"ConversationResolvedStateToggledAttribute","type":"object","required":["isResolved"],"properties":{"isResolved":{"type":"boolean"}}},"ConversationResponse":{"title":"ConversationResponse","type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"}}},"ConversationSearchHit":{"title":"ConversationSearchHit","type":"object","required":["id","highlights"],"properties":{"id":{"description":"Identifier of a Conversation where a match was found","type":"integer","format":"int64"},"highlights":{"$ref":"#/components/schemas/Map_Vector_String"},"innerHits":{"description":"Deprecated: always returned as an empty list.","deprecated":true,"type":"array","items":{"$ref":"#/components/schemas/ConversationSearchInnerHit"}}}},"ConversationSearchInnerHit":{"title":"ConversationSearchInnerHit","type":"object","required":["id","highlight"],"properties":{"id":{"description":"Identifier of a sub-entity (such as a Message) where a match was found","type":"string"},"highlight":{"$ref":"#/components/schemas/Map_String","description":"Snippet of text where a match was found. Matched text will be wrapped in \\<em\\> tags"}}},"ConversationSearchWithFiltersHit":{"title":"ConversationSearchWithFiltersHit","type":"object","required":["id","highlights"],"properties":{"id":{"description":"Identifier of a Conversation where a match was found","type":"integer","format":"int64"},"highlights":{"$ref":"#/components/schemas/Map_Vector_String"}}},"ConversationSubjectUpdatedAttribute":{"title":"ConversationSubjectUpdatedAttribute","type":"object","required":["oldSubject","newSubject"],"properties":{"oldSubject":{"type":"string"},"newSubject":{"type":"string"}}},"ConversationTagsOutput":{"title":"ConversationTagsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"ConversationTranscriptionEndedActivityType":{"title":"ConversationTranscriptionEndedActivityType","type":"object"},"ConversationTranscriptionEndedAttribute":{"title":"ConversationTranscriptionEndedAttribute","type":"object","required":["isSuccessful"],"properties":{"isSuccessful":{"type":"boolean"},"failureReason":{"type":"string"}}},"ConversationTranscriptionStartedActivityType":{"title":"ConversationTranscriptionStartedActivityType","type":"object"},"ConversationTransferredAttribute":{"title":"ConversationTransferredAttribute","type":"object","required":["transferType","destinationType","destinationId"],"properties":{"transferType":{"type":"string"},"destinationType":{"type":"string"},"destinationId":{"type":"string"},"destinationLabel":{"type":"string"},"reason":{"type":"string"}}},"ConversationUnassignedActivityType":{"title":"ConversationUnassignedActivityType","type":"object"},"ConversationUnassignedAttribute":{"title":"ConversationUnassignedAttribute","type":"object","required":["agent"],"properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"}}},"CreateAgentInput":{"title":"CreateAgentInput","type":"object","required":["displayName","email"],"properties":{"displayName":{"description":"The agent's display name","type":"string"},"email":{"description":"The agent's primary email address","type":"string"},"phoneNumber":{"description":"The agent's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The agent's first name","type":"string"},"lastName":{"description":"The agent's last name","type":"string"},"middleNames":{"description":"The agent's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the agent's avatar","type":"string"}}},"CreateAgentsInput":{"title":"CreateAgentsInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateAgentInput"}}}},"CreateAgentsOutput":{"title":"CreateAgentsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_Agent"}}}},"CreateConversationInput":{"title":"CreateConversationInput","oneOf":[{"$ref":"#/components/schemas/Callback"},{"$ref":"#/components/schemas/Chat"},{"$ref":"#/components/schemas/ContactForm"},{"$ref":"#/components/schemas/Email"},{"$ref":"#/components/schemas/Sms"},{"$ref":"#/components/schemas/Whatsapp"}]},"CreateConversationOutput":{"title":"CreateConversationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ConversationResponse"}}},"CreateEndUserInput":{"title":"CreateEndUserInput","type":"object","properties":{"displayName":{"description":"The contact's display name","type":"string"},"email":{"description":"The contact's primary email address","type":"string"},"phoneNumber":{"description":"The contact's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the contact","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the contact","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The contact's first name","type":"string"},"lastName":{"description":"The contact's last name","type":"string"},"middleNames":{"description":"The contact's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the contact's avatar","type":"string"},"externalId":{"description":"Custom external identifier for the contact","type":"string"}}},"CreateEndUserOutput":{"title":"CreateEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}},"CreateEndUsersInput":{"title":"CreateEndUsersInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateEndUserInput"}}}},"CreateEndUsersOutput":{"title":"CreateEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_EndUser"}}}},"CreateInternalNoteInput":{"title":"CreateInternalNoteInput","type":"object","required":["message"],"properties":{"message":{"type":"string"},"agentId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"}}},"CreateKnowledgeArticleInput":{"title":"CreateKnowledgeArticleInput","type":"object","properties":{"translations":{"description":"Initial translations for the article","type":"array","items":{"$ref":"#/components/schemas/TranslationInput"}},"parentId":{"description":"ID of the parent category","type":"string"},"tags":{"description":"List of tag IDs to assign to the article","type":"array","items":{"type":"string"}},"preRelease":{"description":"Whether the article is only available in pre-release mode","type":"boolean"}}},"CreateKnowledgeArticleOutput":{"title":"CreateKnowledgeArticleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Article","description":"The created article"}}},"CreateKnowledgeCategoryInput":{"title":"CreateKnowledgeCategoryInput","type":"object","required":["parentId"],"properties":{"translations":{"description":"Initial translations for the category","type":"array","items":{"$ref":"#/components/schemas/CategoryTranslationInput"}},"parentId":{"description":"ID of the parent. Use a collection ID to create a top-level category, or a category ID to create a subcategory","type":"string"}}},"CreateKnowledgeCategoryOutput":{"title":"CreateKnowledgeCategoryOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Category","description":"The created category"}}},"CreateKnowledgeCollectionInput":{"title":"CreateKnowledgeCollectionInput","type":"object","required":["title"],"properties":{"title":{"description":"Title of the collection","type":"string"},"description":{"description":"Description of the collection","type":"string"},"internalKbEnabled":{"description":"Whether the collection is available to browse in the internal knowledge base. Defaults to true","type":"boolean"}}},"CreateKnowledgeCollectionOutput":{"title":"CreateKnowledgeCollectionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Collection","description":"The created collection"}}},"CreateMessageInput":{"title":"CreateMessageInput","description":"Only Outbound messages are supported for Sms and Whatsapp.","oneOf":[{"$ref":"#/components/schemas/Inbound"},{"$ref":"#/components/schemas/Outbound"}]},"CreateMessageOutput":{"title":"CreateMessageOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CreateMessageOutputData"}}},"CreateMessageOutputData":{"title":"CreateMessageOutputData","type":"object","required":["direction","authorId"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"authorId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"messageId":{"type":"string","format":"uuid"},"createdAt":{"type":"string"}}},"CreateNoteOutput":{"title":"CreateNoteOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InternalNoteData"}}},"CreateOrUpdateQueueRequest":{"title":"CreateOrUpdateQueueRequest","type":"object","required":["name","callFunctionality","isDefault","isDoNotOfferEnabled"],"properties":{"name":{"type":"string"},"callFunctionality":{"type":"boolean"},"isDefault":{"type":"boolean"},"queueThresholds":{"$ref":"#/components/schemas/Map_QueueThreshold_Int"},"offerTimeout":{"type":"integer","format":"int32"},"offerAlgorithm":{"description":"values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]","type":"string"},"wrapupTimeout":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"offerAbandonedConversations":{"type":"boolean"},"doNotOfferTimeouts":{"$ref":"#/components/schemas/Map_ConversationChannel_Int"},"isDoNotOfferEnabled":{"type":"boolean"},"preferredAgentTimeouts":{"$ref":"#/components/schemas/Map_ConversationChannel_Int"},"isPreferredAgentEnabled":{"type":"boolean"},"preferredAgentOfflineTimeout":{"type":"integer","format":"int32"},"personalAgentOfflineTimeout":{"type":"integer","format":"int32"},"isRestricted":{"type":"boolean"}}},"CreateQueueInput":{"title":"CreateQueueInput","type":"object","required":["request"],"properties":{"request":{"$ref":"#/components/schemas/CreateOrUpdateQueueRequest"}}},"CreateQueueOutput":{"title":"CreateQueueOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Queue1"}}},"CreateRatingOfferInput":{"title":"CreateRatingOfferInput","type":"object","required":["ratingType"],"properties":{"userId":{"description":"If userId is not provided, the conversation requester will be picked.","type":"string"},"agentId":{"description":"If an agentId is not provided, the agent that is most likely to be the target will be picked. Please note that providing an agentId that is not part of the conversation may skew metrics in Intelligence.","type":"string"},"ratingType":{"description":"The type of numeric rating. E.g.: 'Csat', 'ThumbsUpOrDown', 'Nps'.","type":"string"},"offeredAt":{"type":"string","format":"date-time"}}},"CreateRatingOfferOutput":{"title":"CreateRatingOfferOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RatingOffer"}}},"CreateRatingResultInput":{"title":"CreateRatingResultInput","type":"object","required":["ratingResult"],"properties":{"userId":{"description":"The userId property is no longer used so it's made optional to keep backwards compatibility. A null value can be provided instead of an actual ID.","deprecated":true,"type":"string"},"ratingResult":{"$ref":"#/components/schemas/SubmittedRatingResult"},"comment":{"type":"string"},"submittedAt":{"type":"string","format":"date-time"}}},"CreateRatingResultOutput":{"title":"CreateRatingResultOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RatingResult"}}},"CreateTagInput":{"title":"CreateTagInput","type":"object","required":["name"],"properties":{"name":{"type":"string"},"color":{"type":"string"}}},"CreateTagOutput":{"title":"CreateTagOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Tag"}}},"CreateTeamInput":{"title":"CreateTeamInput","type":"object","required":["name"],"properties":{"name":{"type":"string"}}},"CreateTeamOutput":{"title":"CreateTeamOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Team1"}}},"CreateTemplateInput":{"title":"CreateTemplateInput","type":"object","required":["name","language","templateType","category"],"properties":{"name":{"description":"Template name; may only contain lowercase letters, digits, and underscores","type":"string"},"language":{"description":"Supported language codes: ar, bg, hr, cs, da, nl, en, et, fi, fr, de, el, he, hu, it, ja, ko, lv, lt, nb, pl, ro, ru, sr, sk, sl, es, sv, th, tr, uk, pt_PT, zh_CN, zh_TW, zh_HK","type":"string"},"templateType":{"$ref":"#/components/schemas/TemplateTypeInput"},"category":{"description":"values: [UTILITY, MARKETING]","type":"string"},"variables":{"$ref":"#/components/schemas/Map_String","description":"Sample values for the template's placeholders (e.g. {\"1\": \"John\"}), submitted to WhatsApp as example content during template approval. Omit for a template whose body has no placeholders."}}},"CreateTemplateOutput":{"title":"CreateTemplateOutput","type":"object","required":["id"],"properties":{"id":{"type":"string"}}},"CreateWebhookSubscriptionInput":{"title":"CreateWebhookSubscriptionInput","type":"object","required":["name","url","authorization","customHeaders"],"properties":{"name":{"description":"The Webhook Subscription name","type":"string"},"events":{"description":"The set of events this Webhook Subscription subscribes to. Allowed values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","type":"array","uniqueItems":true,"items":{"description":"values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","type":"string"}},"url":{"description":"URL of the server that the webhook request should be sent to","type":"string"},"authorization":{"$ref":"#/components/schemas/WebhookAuthorization"},"customHeaders":{"$ref":"#/components/schemas/Map_String","description":"Custom headers that will be added to the webhook request"},"enabled":{"description":"Defines whether this Webhook Subscription is enabled or disabled. Default is `true`","type":"boolean"},"filters":{"$ref":"#/components/schemas/Map_WebhookEventType_Filters","description":"Filters to be applied to the events of the Webhook Subscription, only filtered events will be sent out. Filters can target a conversation channel, queue..."}}},"CreateWebhookSubscriptionOutput":{"title":"CreateWebhookSubscriptionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}},"CreateWhatsappTemplateOutput":{"title":"CreateWhatsappTemplateOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CreateTemplateOutput"}}},"CreationDate":{"title":"CreationDate","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}},"Csat":{"title":"Csat","type":"object","required":["value"],"properties":{"value":{"description":"Numeric value between 1 and 5 representing the customer's satisfaction level.","type":"integer","format":"int32"}}},"CustomAttribute":{"title":"CustomAttribute","type":"object","required":["id","name","identifier","value"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"identifier":{"type":"string"},"value":{"description":"AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"CustomAttribute1":{"title":"CustomAttribute","type":"object","required":["operator","attributeId"],"properties":{"operator":{"$ref":"#/components/schemas/CustomAttributeOperator"},"attributeId":{"type":"string"}}},"CustomAttributeDefinition":{"title":"CustomAttributeDefinition","type":"object","required":["id","entityType","identifier","label","inputDefinition","createdAt","isRequired","isArchived","isDeactivated"],"properties":{"id":{"type":"string","format":"uuid"},"entityType":{"description":"values: [Contact, Conversation]","type":"string"},"identifier":{"type":"string"},"label":{"type":"string"},"inputDefinition":{"$ref":"#/components/schemas/CustomAttributeInputDefinition"},"description":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isRequired":{"type":"boolean"},"isArchived":{"type":"boolean"},"isDeactivated":{"type":"boolean"}}},"CustomAttributeInputDefinition":{"title":"CustomAttributeInputDefinition","oneOf":[{"$ref":"#/components/schemas/Select1"},{"$ref":"#/components/schemas/Text2"}]},"CustomAttributeOperator":{"title":"CustomAttributeOperator","oneOf":[{"$ref":"#/components/schemas/IsEmpty"},{"$ref":"#/components/schemas/IsNotEmpty"},{"$ref":"#/components/schemas/IsNotOneOf2"},{"$ref":"#/components/schemas/IsOneOf2"}]},"DeleteAgentsFromTeamInput":{"title":"DeleteAgentsFromTeamInput","type":"object","properties":{"agentIds":{"type":"array","items":{"type":"string","format":"uuid"}}}},"DeliveryAttemptFailed":{"title":"DeliveryAttemptFailed","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"fulfillmentId":{"description":"External fulfillment ID — links back to the fulfillment","type":"string"},"reason":{"description":"Reason for the failed attempt (e.g. no one home, wrong address)","type":"string"}}},"DeliveryDetail":{"title":"DeliveryDetail","type":"object","required":["deliveryTimestamp","success","responseCode","responseText"],"properties":{"deliveryTimestamp":{"type":"string"},"success":{"type":"boolean"},"responseCode":{"type":"integer","format":"int32"},"responseText":{"type":"string"}}},"DeliveryStatus":{"title":"DeliveryStatus","oneOf":[{"$ref":"#/components/schemas/DeliveryDetail"},{"$ref":"#/components/schemas/NoRecentDelivery"}]},"DeprecatedActivityLogType":{"title":"DeprecatedActivityLogType","description":"Replaced by _type field","deprecated":true,"oneOf":[{"$ref":"#/components/schemas/ConversationAssignedActivityType"},{"$ref":"#/components/schemas/ConversationAutoreplySentActivityType"},{"$ref":"#/components/schemas/ConversationClaimedActivityType"},{"$ref":"#/components/schemas/ConversationClosedActivityType"},{"$ref":"#/components/schemas/ConversationCreatedByAgentActivityType"},{"$ref":"#/components/schemas/ConversationCreatedByCustomerActivityType"},{"$ref":"#/components/schemas/ConversationEndUserReplacedActivityType"},{"$ref":"#/components/schemas/ConversationLanguageUpdatedActivityType"},{"$ref":"#/components/schemas/ConversationOfferAcceptedActivityType"},{"$ref":"#/components/schemas/ConversationOfferRejectedActivityType"},{"$ref":"#/components/schemas/ConversationOfferTimeoutActivityType"},{"$ref":"#/components/schemas/ConversationOfferedActivityType"},{"$ref":"#/components/schemas/ConversationPendingActivityType"},{"$ref":"#/components/schemas/ConversationRatedActivityType"},{"$ref":"#/components/schemas/ConversationRatingCancelledActivityType"},{"$ref":"#/components/schemas/ConversationRatingOfferedActivityType"},{"$ref":"#/components/schemas/ConversationRatingScheduledActivityType"},{"$ref":"#/components/schemas/ConversationRatingUnscheduledActivityType"},{"$ref":"#/components/schemas/ConversationReopenedActivityType"},{"$ref":"#/components/schemas/ConversationReservedType"},{"$ref":"#/components/schemas/ConversationTranscriptionEndedActivityType"},{"$ref":"#/components/schemas/ConversationTranscriptionStartedActivityType"},{"$ref":"#/components/schemas/ConversationUnassignedActivityType"},{"$ref":"#/components/schemas/FollowupAddedActivityType"},{"$ref":"#/components/schemas/FollowupExpiredActivityType"},{"$ref":"#/components/schemas/FollowupRemovedActivityType"},{"$ref":"#/components/schemas/MessageAddedByAgentActivityType"},{"$ref":"#/components/schemas/MessageAddedByCustomerActivityType"},{"$ref":"#/components/schemas/NoteAddedActivityType"},{"$ref":"#/components/schemas/TagAddedActivityType"},{"$ref":"#/components/schemas/TagRemovedActivityType"},{"$ref":"#/components/schemas/TransferFailedActivityType"},{"$ref":"#/components/schemas/TransferInitiatedActivityType"},{"$ref":"#/components/schemas/TransferSuccessfulActivityType"},{"$ref":"#/components/schemas/UnknownActivityType"}]},"DeprecatedAnonymizationType":{"title":"DeprecatedAnonymizationType","description":"Replaced by _type field","deprecated":true,"oneOf":[{"$ref":"#/components/schemas/ConversationAnonymizationType"},{"$ref":"#/components/schemas/MessageAnonymizationType"},{"$ref":"#/components/schemas/UnknownAnonymizationType"},{"$ref":"#/components/schemas/UserAnonymizationType"}]},"Digitalgenius":{"title":"Digitalgenius","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":"The ID of the Dixa user associated with the AI agent, used as `authorId` of a message","type":"string"}}},"Direction":{"title":"Direction","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/DirectionOperator"}}},"DirectionOperator":{"title":"DirectionOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf3"},{"$ref":"#/components/schemas/IsOneOf3"}]},"DoubleAggregateValue":{"title":"DoubleAggregateValue","type":"object","required":["value","measure"],"properties":{"value":{"type":"number","format":"double"},"measure":{"description":"values: [Min, Max, Sum, Percentage, AgentPresenceDuration, StdDev, Average]","type":"string"}}},"DoubleField":{"title":"DoubleField","type":"object","required":["value"],"properties":{"value":{"type":"number","format":"double"}}},"Duration":{"title":"Duration","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/DurationOperator"}}},"DurationOperator":{"title":"DurationOperator","oneOf":[{"$ref":"#/components/schemas/Between1"},{"$ref":"#/components/schemas/LongerThanOrEqualTo"},{"$ref":"#/components/schemas/ShorterThanOrEqualTo"}]},"Email":{"title":"Email","type":"object","required":["requesterId","emailIntegrationId","subject","message"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"emailIntegrationId":{"type":"string"},"subject":{"type":"string"},"message":{"$ref":"#/components/schemas/CreateMessageInput"},"language":{"type":"string"}}},"Email1":{"title":"Email","type":"object","required":["value"],"properties":{"value":{"description":"Email address","type":"string"}}},"EmailAttributes":{"title":"EmailAttributes","type":"object","required":["from","isAutoReply"],"properties":{"emailContent":{"$ref":"#/components/schemas/EmailContent"},"from":{"$ref":"#/components/schemas/EmailContact"},"to":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"cc":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"bcc":{"type":"array","items":{"$ref":"#/components/schemas/EmailContact"}},"isAutoReply":{"type":"boolean"},"inlineImages":{"description":"Files the sender embedded in the message body, such as the images that `emailContent` references. The sending email client decides whether a file is embedded or attached, so a file you would expect in `attachments` can arrive here instead. Read both fields to get every file on the message.","type":"array","items":{"$ref":"#/components/schemas/File"}},"attachments":{"description":"Files the sender attached to the message. Files the sender embedded in the message body are listed in `inlineImages` instead.","type":"array","items":{"$ref":"#/components/schemas/File"}},"deliveryFailureReason":{"type":"string"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"originalContentUrl":{"$ref":"#/components/schemas/File"}}},"EmailAutoReply":{"title":"EmailAutoReply","type":"object","required":["id","name","content","createdBy","createdAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"content":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string"},"lastEditedBy":{"type":"string"},"lastEditedAt":{"type":"string"},"translations":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/Translation"}},"subject":{"type":"string"}}},"EmailContact":{"title":"EmailContact","type":"object","required":["email"],"properties":{"email":{"type":"string"},"name":{"type":"string"}}},"EmailContent":{"title":"EmailContent","oneOf":[{"$ref":"#/components/schemas/Regular"},{"$ref":"#/components/schemas/TooLarge"}]},"EmailConversation":{"title":"EmailConversation","type":"object","required":["id","requesterId","channel","createdAt","toEmail","fromEmail","integrationEmail"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"toEmail":{"type":"string"},"fromEmail":{"type":"string"},"integrationEmail":{"type":"string"},"language":{"type":"string"},"subject":{"type":"string"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"EmailEndpoint":{"title":"EmailEndpoint","type":"object","required":["address"],"properties":{"address":{"type":"string"},"senderOverride":{"type":"string"},"name":{"type":"string"}}},"EmailForward":{"title":"EmailForward","type":"object","required":["parentId"],"properties":{"parentId":{"type":"integer","format":"int64"}}},"EmptyPatchSet":{"title":"EmptyPatchSet","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}},"EndUser":{"title":"EndUser","type":"object","required":["id","createdAt"],"properties":{"id":{"description":"Unique identifier for the contact","type":"string","format":"uuid"},"createdAt":{"description":"Time when the contact was created","type":"string","format":"date-time"},"displayName":{"description":"The contact's display name","type":"string"},"email":{"description":"The contact's primary email address","type":"string"},"phoneNumber":{"description":"The contact's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the contact","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the contact","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The contact's first name","type":"string"},"lastName":{"description":"The contact's last name","type":"string"},"middleNames":{"description":"The contact's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the contact's avatar","type":"string"},"externalId":{"description":"Custom external identifier for the contact","type":"string"},"customAttributes":{"description":"Custom attributes for the contact","type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}}}},"ErrorResponse":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"EventDeliveryLog":{"title":"EventDeliveryLog","type":"object","required":["deliveryDetail","payload"],"properties":{"deliveryDetail":{"$ref":"#/components/schemas/DeliveryDetail"},"payload":{"type":"string"}}},"EventDeliveryStatus":{"title":"EventDeliveryStatus","type":"object","required":["event","deliveryStatus"],"properties":{"event":{"description":"values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","type":"string"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"}}},"Exception":{"title":"Exception","type":"object"},"Exception1":{"title":"Exception","type":"object"},"ExcludesAll":{"title":"ExcludesAll","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"ExcludesOne":{"title":"ExcludesOne","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"FacebookMessengerAttributes":{"title":"FacebookMessengerAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"FacebookMessengerConversation":{"title":"FacebookMessengerConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"Failure":{"title":"Failure","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/ChannelAvailabilityError"}}},"Field":{"title":"Field","type":"object","required":["name"],"properties":{"name":{"type":"string"},"field":{"$ref":"#/components/schemas/FieldType"}}},"FieldCanHaveMultipleValuesOrBeEmptyOperator":{"title":"FieldCanHaveMultipleValuesOrBeEmptyOperator","oneOf":[{"$ref":"#/components/schemas/ExcludesAll"},{"$ref":"#/components/schemas/ExcludesOne"},{"$ref":"#/components/schemas/IncludesAll"},{"$ref":"#/components/schemas/IncludesOne"},{"$ref":"#/components/schemas/IsEmpty"},{"$ref":"#/components/schemas/IsNotEmpty"}]},"FieldCanHaveSingleValueOrBeEmptyOperator":{"title":"FieldCanHaveSingleValueOrBeEmptyOperator","oneOf":[{"$ref":"#/components/schemas/IsEmpty"},{"$ref":"#/components/schemas/IsNotEmpty"},{"$ref":"#/components/schemas/IsNotOneOf"},{"$ref":"#/components/schemas/IsOneOf"}]},"FieldHasSingleValueOperator":{"title":"FieldHasSingleValueOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf"},{"$ref":"#/components/schemas/IsOneOf"}]},"FieldMetadata":{"title":"FieldMetadata","type":"object","required":["field","description","nullable"],"properties":{"field":{"type":"string"},"description":{"type":"string"},"nullable":{"type":"boolean"}}},"FieldType":{"title":"FieldType","oneOf":[{"$ref":"#/components/schemas/BooleanField"},{"$ref":"#/components/schemas/DoubleField"},{"$ref":"#/components/schemas/InstantField"},{"$ref":"#/components/schemas/IntField"},{"$ref":"#/components/schemas/ListField"},{"$ref":"#/components/schemas/LongField"},{"$ref":"#/components/schemas/StringField"},{"$ref":"#/components/schemas/TimestampField"},{"$ref":"#/components/schemas/UUIDField"}]},"File":{"title":"File","type":"object","required":["url"],"properties":{"url":{"description":"url","type":"string"},"prettyName":{"type":"string"}}},"FileMeta":{"title":"FileMeta","type":"object","required":["url","name","mediaType","bytesLength","checksum"],"properties":{"url":{"type":"string"},"name":{"type":"string"},"mediaType":{"$ref":"#/components/schemas/MimeType"},"bytesLength":{"type":"integer","format":"int64"},"checksum":{"$ref":"#/components/schemas/Checksum"}}},"Filter":{"title":"Filter","type":"object","required":["attribute"],"properties":{"attribute":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}},"FilterDescriptor":{"title":"FilterDescriptor","description":"A filter the metric or record supports","type":"object","required":["attribute","type","defaultOperator","description"],"properties":{"attribute":{"description":"The value to use as a filter's `attribute`","type":"string"},"aliases":{"description":"Other names you can use for the attribute. Responses always use `attribute`","type":"array","items":{"type":"string"}},"type":{"description":"The type of the filter values","type":"string","enum":["String","Integer","Number","Boolean","Uuid","Timestamp","Entity","List","Object"]},"operators":{"description":"The operators the attribute supports","type":"array","items":{"type":"string","enum":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"]}},"defaultOperator":{"description":"The operator used when a filter has no `operator`","type":"string","enum":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"]},"description":{"description":"A description of the filter","type":"string"}}},"FilterMetadata":{"title":"FilterMetadata","type":"object","required":["filterAttribute"],"properties":{"filterAttribute":{"type":"string"},"description":{"type":"string"}}},"FilterValue":{"title":"FilterValue","type":"object","required":["value"],"properties":{"value":{"type":"string"},"label":{"type":"string"}}},"Filters":{"title":"Filters","type":"object","required":["strategy"],"properties":{"strategy":{"description":"values: [All, Any]","type":"string"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}}}},"Filters1":{"title":"Filters","oneOf":[{"$ref":"#/components/schemas/CombinedFilters"}]},"FollowUp":{"title":"FollowUp","type":"object","required":["parentId"],"properties":{"parentId":{"type":"integer","format":"int64"}}},"FollowupAddedActivityType":{"title":"FollowupAddedActivityType","type":"object"},"FollowupConversationInput":{"title":"FollowupConversationInput","type":"object","required":["timestamp"],"properties":{"timestamp":{"description":"A timestamp for when the followup should expire","type":"string","format":"date-time"},"userId":{"description":"An optional agent/admin/AI agent to followup the conversation. If not provided, the System User will be used.","type":"string","format":"uuid"}}},"FollowupExpiredActivityType":{"title":"FollowupExpiredActivityType","type":"object"},"FollowupRemovedActivityType":{"title":"FollowupRemovedActivityType","type":"object"},"FormAttributeValue":{"title":"FormAttributeValue","oneOf":[{"$ref":"#/components/schemas/Attachments"},{"$ref":"#/components/schemas/Select"},{"$ref":"#/components/schemas/Text1"}]},"FormSubmission":{"title":"FormSubmission","type":"object","required":["values"],"properties":{"values":{"$ref":"#/components/schemas/Map_FormAttributeValue"}}},"FulfillmentLineItem":{"title":"FulfillmentLineItem","type":"object","required":["label","quantity"],"properties":{"label":{"type":"string"},"reference":{"description":"SKU or other external reference for the product","type":"string"},"quantity":{"description":"Number of units fulfilled","type":"integer","format":"int32"}}},"GenericAttributes":{"title":"GenericAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"GenericChannel":{"title":"GenericChannel","type":"object","required":["genericChannelName","availability"],"properties":{"genericChannelName":{"type":"string"},"availability":{"description":"values: [Available, NotAvailable]","type":"string"},"queueSize":{"description":"The number of conversations currently waiting in the queue. This field will only be present if the queue availability is NotAvailable.","type":"integer","format":"int32"}}},"GenericConversation":{"title":"GenericConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"fromContactPointId":{"type":"string"},"toContactPointId":{"type":"string"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"GenericConversationImport":{"title":"GenericConversationImport","type":"object","required":["genericChannelName","requesterId","direction","createdAt"],"properties":{"genericChannelName":{"description":"The conversation channel. Currently supported values are 'email' and 'genericapimessaging'. See payload examples for each case.","type":"string"},"requesterId":{"type":"string","format":"uuid"},"requesterConnectionStatus":{"description":"values: [Connected, Disconnected]","type":"string"},"direction":{"description":"values: [Inbound, Outbound]","type":"string"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ImportMessageInput"}},"createdAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"externalId":{"type":"string"},"closing":{"$ref":"#/components/schemas/Closing"},"attributes":{"description":"A set of dynamic attributes that are specific to the conversation channel, but not limited to it. See channel specific examples for your use case."}}},"Genericapimessaging":{"title":"Genericapimessaging","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":"The ID of the Dixa user associated with the AI agent, used as `authorId` of a message","type":"string"}}},"GetActivityLogOutput":{"title":"GetActivityLogOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityLogEntry"}}}},"GetBusinessHoursScheduleDefinitionOutput":{"title":"GetBusinessHoursScheduleDefinitionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetBusinessHoursScheduleDefinitionResult"}}},"GetBusinessHoursScheduleDefinitionResult":{"title":"GetBusinessHoursScheduleDefinitionResult","type":"object","required":["schedule"],"properties":{"schedule":{"$ref":"#/components/schemas/BusinessHoursScheduleDefinition"}}},"GetBusinessOpenStatusOutput":{"title":"GetBusinessOpenStatusOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetBusinessOpenStatusResult"}}},"GetBusinessOpenStatusResult":{"title":"GetBusinessOpenStatusResult","type":"object","required":["isOpen","timestamp"],"properties":{"isOpen":{"description":"Whether the business is open at the evaluated timestamp","type":"boolean"},"timestamp":{"description":"The timestamp the status was evaluated at","type":"string","format":"date-time"},"opensAt":{"description":"When the business next opens. Only present while the business is closed and there is an upcoming open interval within the next year; null while the business is open","type":"string","format":"date-time"},"closesAt":{"description":"When the current open interval ends. Only present while the business is open; null while it is closed","type":"string","format":"date-time"}}},"GetContactPointByIdOutput":{"title":"GetContactPointByIdOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ContactEndpoint"}}},"GetConversationOutput":{"title":"GetConversationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Conversation"}}},"GetCustomAttributesDefinitionsOutput":{"title":"GetCustomAttributesDefinitionsOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeDefinition"}}},"GetEndUserOutput":{"title":"GetEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}},"GetFilterValuesOutput":{"title":"GetFilterValuesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FilterValue"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"GetKnowledgeArticleOutput":{"title":"GetKnowledgeArticleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Article"}}},"GetKnowledgeArticleTranslationsOutput":{"title":"GetKnowledgeArticleTranslationsOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ArticleTranslations"}}},"GetKnowledgeCategoryOutput":{"title":"GetKnowledgeCategoryOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Category"}}},"GetKnowledgeCategoryTranslationsOutput":{"title":"GetKnowledgeCategoryTranslationsOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CategoryTranslations"}}},"GetKnowledgeCollectionCatalogOutput":{"title":"GetKnowledgeCollectionCatalogOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionCatalogItem"}}},"GetKnowledgeCollectionOutput":{"title":"GetKnowledgeCollectionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Collection"}}},"GetMetricDataInput":{"title":"GetMetricDataInput","oneOf":[{"$ref":"#/components/schemas/GetMetricDataInputCsidFilter"},{"$ref":"#/components/schemas/GetMetricDataInputPeriodFilter"}]},"GetMetricDataInputCsidFilter":{"title":"GetMetricDataInputCsidFilter","type":"object","required":["id","timezone"],"properties":{"id":{"type":"string"},"csidFilter":{"type":"array","minItems":1,"items":{"type":"integer","format":"int64"}},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"aggregations":{"type":"array","items":{"description":"values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]","type":"string"}},"timezone":{"type":"string"}}},"GetMetricDataInputPeriodFilter":{"title":"GetMetricDataInputPeriodFilter","type":"object","required":["id","periodFilter","timezone"],"properties":{"id":{"type":"string"},"periodFilter":{"$ref":"#/components/schemas/PeriodFilter"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"aggregations":{"type":"array","items":{"description":"values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]","type":"string"}},"timezone":{"type":"string"}}},"GetMetricDataOutput":{"title":"GetMetricDataOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricData"}}},"GetMetricOutput":{"title":"GetMetricOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricMetadata"}}},"GetMetricRecordOutput":{"title":"GetMetricRecordOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricRecordMetadata"}}},"GetMetricRecordsDataInput":{"title":"GetMetricRecordsDataInput","oneOf":[{"$ref":"#/components/schemas/GetMetricRecordsDataInputCsidFilter"},{"$ref":"#/components/schemas/GetMetricRecordsDataInputPeriodFilter"}]},"GetMetricRecordsDataInputCsidFilter":{"title":"GetMetricRecordsDataInputCsidFilter","type":"object","required":["id","timezone"],"properties":{"id":{"type":"string"},"csidFilter":{"type":"array","minItems":1,"items":{"type":"integer","format":"int64"}},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"timezone":{"type":"string"}}},"GetMetricRecordsDataInputPeriodFilter":{"title":"GetMetricRecordsDataInputPeriodFilter","type":"object","required":["id","periodFilter","timezone"],"properties":{"id":{"type":"string"},"periodFilter":{"$ref":"#/components/schemas/PeriodFilter"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/Filter"}},"timezone":{"type":"string"}}},"GetMetricRecordsDataOutput":{"title":"GetMetricRecordsDataOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricRecord"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"GetMetricRecordsOutput":{"title":"GetMetricRecordsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricRecordMetadata"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"GetMetricsOutput":{"title":"GetMetricsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricMetadata"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"GetOrganizationOutput":{"title":"GetOrganizationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OrganizationDetails"}}},"GetQueueByIdOutput":{"title":"GetQueueByIdOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Queue1"}}},"GetQueuedConversationPositionOutput":{"title":"GetQueuedConversationPositionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QueuedConversation"}}},"GetTagOutput":{"title":"GetTagOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Tag"}}},"GetUpcomingBusinessHoursScheduleOutput":{"title":"GetUpcomingBusinessHoursScheduleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetUpcomingBusinessHoursScheduleResult"}}},"GetUpcomingBusinessHoursScheduleResult":{"title":"GetUpcomingBusinessHoursScheduleResult","type":"object","required":["schedule"],"properties":{"schedule":{"$ref":"#/components/schemas/BusinessHoursUpcomingSchedule"}}},"GetWebhookEventDeliveryLogsOutput":{"title":"GetWebhookEventDeliveryLogsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventDeliveryLog"}}}},"GetWebhookLastDeliveryStatusOutput":{"title":"GetWebhookLastDeliveryStatusOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventDeliveryStatus"}}}},"GetWebhookSubscriptionOutput":{"title":"GetWebhookSubscriptionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}},"GetWhatsappTemplateOutput":{"title":"GetWhatsappTemplateOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WhatsappTemplate"}}},"HelpCenterLink":{"title":"HelpCenterLink","type":"object","required":["id","name","url"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}},"Holiday":{"title":"Holiday","type":"object"},"Holiday1":{"title":"Holiday","type":"object"},"Html":{"title":"Html","type":"object","required":["value"],"properties":{"value":{"type":"string"}}},"ImportConversationOutput":{"title":"ImportConversationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImportConversationResponse"}}},"ImportConversationResponse":{"title":"ImportConversationResponse","type":"object","required":["id"],"properties":{"id":{"description":"The id of the newly imported conversation","type":"integer","format":"int64"},"partialErrors":{"description":"List of errors that do not prevent the conversation from being created","type":"array","items":{"$ref":"#/components/schemas/PartialError"}}}},"ImportMessageInput":{"title":"ImportMessageInput","oneOf":[{"$ref":"#/components/schemas/InboundImport"},{"$ref":"#/components/schemas/OutboundImport"}]},"Inbound":{"title":"Inbound","type":"object","required":["content"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"integrationEmail":{"description":"Internal email address registered for the integration with format: \\<email-address\\>@email.dixa.io","type":"string"},"externalId":{"description":"Client generated identifier for external reference","type":"string"}}},"InboundImport":{"title":"InboundImport","type":"object","required":["content","createdAt"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"externalId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"attributes":{"description":"A set of dynamic attributes that are specific to the conversation channel, but not limited to it. See channel specific examples for your use case."}}},"IncludesAll":{"title":"IncludesAll","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"IncludesOne":{"title":"IncludesOne","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"Infrastructure":{"title":"Infrastructure","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}},"InheritedRestriction":{"title":"InheritedRestriction","type":"object","properties":{"fromCollection":{"description":"ID of the collection the restriction is inherited from. Empty if it comes from a category","type":"string"},"fromCategory":{"description":"ID of the category the restriction is inherited from. Empty if it comes from a collection","type":"string"}}},"InstantField":{"title":"InstantField","type":"object","required":["value"],"properties":{"value":{"type":"string","format":"date-time"}}},"IntField":{"title":"IntField","type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"int32"}}},"Integrity":{"title":"Integrity","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}},"IntelligenceFilterValue":{"title":"IntelligenceFilterValue","description":"A value of a filter attribute","type":"object","required":["id"],"properties":{"id":{"description":"The value to use in a filter's `values`","type":"string"},"label":{"description":"The display name","type":"string"},"deactivated":{"description":"Whether the agent, queue, tag or SLA policy is deactivated. Not set for other attributes","type":"boolean"}}},"IntelligenceFilterValuePage":{"title":"IntelligenceFilterValuePage","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IntelligenceFilterValue"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"IntelligenceInterval":{"title":"IntelligenceInterval","description":"A time range. Both ends are ISO 8601 timestamps that must end in `Z` or a UTC offset, such as `2026-06-01T00:00:00Z` or `2026-06-01T00:00:00+02:00`","type":"object","required":["from","to"],"properties":{"from":{"description":"The start of the range, inclusive. Must be before `to`","type":"string","format":"date-time"},"to":{"description":"The end of the range, inclusive","type":"string","format":"date-time"}}},"IntelligenceMetric":{"title":"IntelligenceMetric","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricCatalogueEntry"}}},"IntelligenceMetricCatalogue":{"title":"IntelligenceMetricCatalogue","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricCatalogueEntry"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"IntelligenceMetricValues":{"title":"IntelligenceMetricValues","type":"object","required":["data"],"properties":{"data":{"description":"The metric values, keyed by the `name` of each of the metric's `aggregates`. All aggregates are included. If nothing matches, `count` is 0, `min`, `max`, `sum`, `average`, `stdDev` and `percentage` are null, and an object value is filled with zeros","type":"object","additionalProperties":{}}}},"IntelligenceRecord":{"title":"IntelligenceRecord","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RecordCatalogueEntry"}}},"IntelligenceRecordCatalogue":{"title":"IntelligenceRecordCatalogue","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RecordCatalogueEntry"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"IntelligenceRecordPage":{"title":"IntelligenceRecordPage","type":"object","required":["meta"],"properties":{"data":{"description":"The rows of the page. The columns a row can contain are listed under `fields` in the record's catalogue entry","type":"array","items":{"description":"A row, keyed by the `name` of each of the record's `fields`. Columns without a value are left out, so rows can have different keys","type":"object","additionalProperties":{}}},"meta":{"$ref":"#/components/schemas/PageResponse"}}},"InternalNoteData":{"title":"InternalNoteData","type":"object","required":["id","authorId","createdAt","csid","message"],"properties":{"id":{"type":"string","format":"uuid"},"authorId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"csid":{"type":"integer","format":"int64"},"message":{"type":"string"}}},"Interval":{"title":"Interval","type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}},"IntervalPeriod":{"title":"IntervalPeriod","description":"A period between two points in time","type":"object","required":["interval"],"properties":{"interval":{"$ref":"#/components/schemas/IntelligenceInterval"}}},"InvalidArgument":{"title":"InvalidArgument","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"IsEmpty":{"title":"IsEmpty","type":"object"},"IsNotEmpty":{"title":"IsNotEmpty","type":"object"},"IsNotOneOf":{"title":"IsNotOneOf","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"IsNotOneOf1":{"title":"IsNotOneOf","type":"object","required":["values"],"properties":{"values":{"description":"values: [email, contactform, chat, dixamessenger, phone, voicemail, callback, sms, facebookmessenger, whatsapp, adachat, digitalgeniuschat, kindlychat, genericapimessaging, trustpilot, yotpo]","type":"array","items":{"type":"string"}}}},"IsNotOneOf2":{"title":"IsNotOneOf","type":"object","properties":{"values":{"description":"Array of arrays of strings. Each inner array represents a possible custom attribute value.<br>If custom attribute is of type Select, either a parent value can be provided or a child value, but with a whole path to its parent value. Example: [[\"parent\"], [\"parent\", \"child1\", \"child2\", \"child3\"], [\"parent\", \"child1\"]].<br>If custom attribute is of type Text, each search value must be wrapped in an array too. Example: [[\"value1\"]]","type":"array","items":{"type":"array","items":{"type":"string"}}}}},"IsNotOneOf3":{"title":"IsNotOneOf","type":"object","required":["values"],"properties":{"values":{"description":"values: [inbound, outbound, internal]","type":"array","items":{"type":"string"}}}},"IsNotOneOf4":{"title":"IsNotOneOf","type":"object","required":["values"],"properties":{"values":{"description":"values: [open, closed, pending]","type":"array","items":{"type":"string"}}}},"IsNotOneOf5":{"title":"IsNotOneOf","type":"object","required":["field","values"],"properties":{"field":{"description":"values: [InitialChannel, OperationOrigin, QueueId]","type":"string"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}},"IsOneOf":{"title":"IsOneOf","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}},"IsOneOf1":{"title":"IsOneOf","type":"object","required":["values"],"properties":{"values":{"description":"values: [email, contactform, chat, dixamessenger, phone, voicemail, callback, sms, facebookmessenger, whatsapp, adachat, digitalgeniuschat, kindlychat, genericapimessaging, trustpilot, yotpo]","type":"array","items":{"type":"string"}}}},"IsOneOf2":{"title":"IsOneOf","type":"object","properties":{"values":{"description":"Array of arrays of strings. Each inner array represents a possible custom attribute value.<br>If custom attribute is of type Select, either a parent value can be provided or a child value, but with a whole path to its parent value. Example: [[\"parent\"], [\"parent\", \"child1\", \"child2\", \"child3\"], [\"parent\", \"child1\"]].<br>If custom attribute is of type Text, each search value must be wrapped in an array too. Example: [[\"value1\"]]","type":"array","items":{"type":"array","items":{"type":"string"}}}}},"IsOneOf3":{"title":"IsOneOf","type":"object","required":["values"],"properties":{"values":{"description":"values: [inbound, outbound, internal]","type":"array","items":{"type":"string"}}}},"IsOneOf4":{"title":"IsOneOf","type":"object","required":["values"],"properties":{"values":{"description":"values: [open, closed, pending]","type":"array","items":{"type":"string"}}}},"IsOneOf5":{"title":"IsOneOf","type":"object","required":["field","values"],"properties":{"field":{"description":"values: [InitialChannel, OperationOrigin, QueueId]","type":"string"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}},"Kindly":{"title":"Kindly","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":"The ID of the Dixa user associated with the AI agent, used as `authorId` of a message","type":"string"}}},"LastActivity":{"title":"LastActivity","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}},"LastMessage":{"title":"LastMessage","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}},"LineItem":{"title":"LineItem","type":"object","required":["label","quantity","amount"],"properties":{"label":{"type":"string"},"reference":{"description":"SKU or other external reference for the product","type":"string"},"quantity":{"description":"Number of units","type":"integer","format":"int32"},"amount":{"$ref":"#/components/schemas/Money","description":"Total amount for this line item, inclusive of tax and discounts"}}},"LinkConversationInput":{"title":"LinkConversationInput","type":"object","required":["parentId","linkType"],"properties":{"parentId":{"type":"integer","format":"int64"},"linkType":{"description":"values: [Related, SideConversation]","type":"string"}}},"ListActivityLogOutput":{"title":"ListActivityLogOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityLogEntry"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"ListAgentsOutput":{"title":"ListAgentsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"ListAiAgentsOutput":{"title":"ListAiAgentsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AiAgent"}}}},"ListBusinessHoursSchedulesOutput":{"title":"ListBusinessHoursSchedulesOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ListBusinessHoursSchedulesResult"}}},"ListBusinessHoursSchedulesResult":{"title":"ListBusinessHoursSchedulesResult","type":"object","properties":{"schedules":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHoursSchedule"}}}},"ListContactPointsOutput":{"title":"ListContactPointsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactEndpoint"}}}},"ListConversationRatingsOutput":{"title":"ListConversationRatingsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationRating"}}}},"ListCustomAttributesDefinitionsOutput":{"title":"ListCustomAttributesDefinitionsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttributeDefinition"}}}},"ListEndUserConversationsOutput":{"title":"ListEndUserConversationsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"ListEndUsersOutput":{"title":"ListEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EndUser"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"ListField":{"title":"ListField","type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PrimitiveField"}}}},"ListFlowsOutput":{"title":"ListFlowsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationFlow"}}}},"ListInternalNotesOutput":{"title":"ListInternalNotesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InternalNoteData"}}}},"ListKnowledgeCollectionsOutput":{"title":"ListKnowledgeCollectionsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}}}},"ListLinkedConversationsOutput":{"title":"ListLinkedConversationsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}}}},"ListMessagesOutput":{"title":"ListMessagesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"ListPresenceOutput":{"title":"ListPresenceOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserPresence"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"ListQueuesOutput":{"title":"ListQueuesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Queue1"}}}},"ListTagsOutput":{"title":"ListTagsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}},"ListTeamMembersOutput":{"title":"ListTeamMembersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}},"ListTeamsOutput":{"title":"ListTeamsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Team1"}}}},"ListTemplatesOutput":{"title":"ListTemplatesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Template"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"ListWebhookSubscriptionsEndpointOutput":{"title":"ListWebhookSubscriptionsEndpointOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"ListWhatsappTemplatesOutput":{"title":"ListWhatsappTemplatesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateListItem"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"LongAggregateValue":{"title":"LongAggregateValue","type":"object","required":["value","measure"],"properties":{"value":{"type":"integer","format":"int64"},"measure":{"description":"values: [Count]","type":"string"}}},"LongField":{"title":"LongField","type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"int64"}}},"LongerThanOrEqualTo":{"title":"LongerThanOrEqualTo","description":"In milliseconds; for example: '10800000' (3 hours)","type":"object","required":["duration"],"properties":{"duration":{"type":"integer","format":"int64"}}},"Map_AttributeValue":{"title":"Map_AttributeValue","type":"object","additionalProperties":{"description":"AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},"Map_ConversationChannel_Int":{"title":"Map_ConversationChannel_Int","description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"object","additionalProperties":{"type":"integer","format":"int32"}},"Map_ConversationChannel_Set_String":{"title":"Map_ConversationChannel_Set_String","description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"object","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string"}}},"Map_FormAttributeValue":{"title":"Map_FormAttributeValue","type":"object","additionalProperties":{"$ref":"#/components/schemas/FormAttributeValue"}},"Map_QueueThreshold_Int":{"title":"Map_QueueThreshold_Int","description":"values: [SlaTimeLimit, AvailableAgents, LongestWait, SlaPercentage, WaitingConversations]","type":"object","additionalProperties":{"type":"integer","format":"int32"}},"Map_String":{"title":"Map_String","type":"object","additionalProperties":{"type":"string"}},"Map_UUID_Option_AttributeValue":{"title":"Map_UUID_Option_AttributeValue","type":"object","additionalProperties":{"description":"AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text","oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}},"Map_Vector_String":{"title":"Map_Vector_String","description":"Snippet of text where a match was found. Matched text will be wrapped in \\<em\\> tags.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Map_WebhookEventType_Filters":{"title":"Map_WebhookEventType_Filters","type":"object","additionalProperties":{"$ref":"#/components/schemas/Filters1"}},"Markdown":{"title":"Markdown","type":"object","required":["value"],"properties":{"value":{"type":"string"}}},"Media":{"title":"Media","type":"object","required":["body","mediaUrl"],"properties":{"body":{"description":"Template body text; maximum 1024 characters","type":"string"},"mediaUrl":{"type":"string"}}},"Message":{"title":"Message","type":"object","required":["id","authorId","createdAt","attributes"],"properties":{"id":{"type":"string","format":"uuid"},"authorId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"attributes":{"$ref":"#/components/schemas/Attributes"}}},"MessageAddedAttribute":{"title":"MessageAddedAttribute","type":"object","required":["messageId"],"properties":{"messageId":{"type":"string"},"fromEndpoint":{"type":"string"},"avatarUrl":{"type":"string"}}},"MessageAddedByAgentActivityType":{"title":"MessageAddedByAgentActivityType","type":"object"},"MessageAddedByCustomerActivityType":{"title":"MessageAddedByCustomerActivityType","type":"object"},"MessageAnonymizationType":{"title":"MessageAnonymizationType","type":"object"},"MessageRedactedAttribute":{"title":"MessageRedactedAttribute","type":"object","required":["messageId","wasTextRedacted","numberOfDeletedFiles"],"properties":{"messageId":{"type":"string"},"wasTextRedacted":{"type":"boolean"},"numberOfDeletedFiles":{"type":"integer","format":"int32"}}},"MessengerConversation":{"title":"MessengerConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"browserInfo":{"$ref":"#/components/schemas/BrowserInfo"},"language":{"type":"string"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"MessengerFormAttributes":{"title":"MessengerFormAttributes","type":"object","required":["formSubmission"],"properties":{"formSubmission":{"$ref":"#/components/schemas/FormSubmission"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"content":{"$ref":"#/components/schemas/Content"}}},"MetricAggregate":{"title":"MetricAggregate","description":"A value the metric returns","type":"object","required":["name","type","defaultIncluded","description"],"properties":{"name":{"description":"The key of the value in the response","type":"string"},"type":{"description":"The type of the value","type":"string","enum":["String","Integer","Number","Boolean","Uuid","Timestamp","Entity","List","Object"]},"unit":{"description":"The unit of the value, such as milliseconds. Not set when the value has no unit","type":"string"},"defaultIncluded":{"description":"Whether the value is returned by default. All values are currently returned","type":"boolean"},"description":{"description":"A description of the value","type":"string"}}},"MetricCatalogueEntry":{"title":"MetricCatalogueEntry","description":"A metric and how to query it","type":"object","required":["id","name","category","description","deprecated"],"properties":{"id":{"description":"The metric id, used in the URL when you query the metric","type":"string"},"name":{"description":"The display name","type":"string"},"category":{"description":"`conversations`, `agents` or `aiagents`. Decides which endpoint you query the metric with","type":"string"},"description":{"description":"A short description of the metric","type":"string"},"definition":{"description":"How the metric is calculated, if documented","type":"string"},"deprecated":{"description":"Whether the metric will be removed. A deprecated metric can still be queried","type":"boolean"},"primaryFilters":{"description":"The keys the `primaryFilter` of a query supports: `period`, `conversationIds` or both","type":"array","items":{"type":"string"}},"filters":{"description":"The filters the metric supports","type":"array","items":{"$ref":"#/components/schemas/FilterDescriptor"}},"aggregates":{"description":"The values the metric returns","type":"array","items":{"$ref":"#/components/schemas/MetricAggregate"}},"relatedRecordIds":{"description":"The records the metric is based on","type":"array","items":{"type":"string"}}}},"MetricData":{"title":"MetricData","type":"object","required":["id"],"properties":{"id":{"type":"string"},"aggregates":{"type":"array","items":{"$ref":"#/components/schemas/AggregateValue"}}}},"MetricMetadata":{"title":"MetricMetadata","type":"object","required":["id"],"properties":{"id":{"description":"The metric ID","type":"string"},"description":{"description":"Relevant information about the metric","type":"string"},"filters":{"description":"List of available filters that can be used when fetching metric data","type":"array","items":{"$ref":"#/components/schemas/FilterMetadata"}},"aggregations":{"description":"List of available aggregations that can be used when fetching metric data","type":"array","items":{"$ref":"#/components/schemas/AggregateMetadata"}},"relatedRecordIds":{"description":"List of record IDs used to compose the metric","type":"array","items":{"type":"string"}}}},"MetricRecord":{"title":"MetricRecord","type":"object","required":["primaryTimestampField"],"properties":{"primaryTimestampField":{"$ref":"#/components/schemas/TimestampField"},"value":{"$ref":"#/components/schemas/FieldType"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}}}},"MetricRecordMetadata":{"title":"MetricRecordMetadata","type":"object","required":["id","description"],"properties":{"id":{"description":"The record ID","type":"string"},"description":{"description":"Relevant information about the record","type":"string"},"filters":{"description":"List of available filters that can be used when fetching record data","type":"array","items":{"$ref":"#/components/schemas/FilterMetadata"}},"relatedMetricIds":{"description":"List of metric IDs that make use of this record","type":"array","items":{"type":"string"}},"fieldsMetadata":{"description":"Information about the individual record fields","type":"array","items":{"$ref":"#/components/schemas/FieldMetadata"}}}},"MimAutomation":{"title":"MimAutomation","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":"The ID of the Dixa user associated with the AI agent, used as `authorId` of a message","type":"string"}}},"MimSupport":{"title":"MimSupport","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":"The ID of the Dixa user associated with the AI agent, used as `authorId` of a message","type":"string"}}},"MimeType":{"title":"MimeType","oneOf":[{"$ref":"#/components/schemas/MimeTypeImpl"}]},"MimeTypeImpl":{"title":"MimeTypeImpl","type":"object","required":["primary","sub"],"properties":{"primary":{"type":"string"},"sub":{"type":"string"}}},"Money":{"title":"Money","type":"object","required":["amount","currency"],"properties":{"amount":{"description":"Amount in the smallest currency unit (e.g. cents for EUR/USD, pence for GBP)","type":"integer","format":"int64"},"currency":{"description":"ISO 4217 currency code (e.g. EUR, USD, GBP)","type":"string"}}},"NoAuth":{"title":"NoAuth","type":"object"},"NoRecentDelivery":{"title":"NoRecentDelivery","type":"object"},"NotFound":{"title":"NotFound","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"NotFound1":{"title":"NotFound","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}},"NoteAddedActivityType":{"title":"NoteAddedActivityType","type":"object"},"NoteAddedAttribute":{"title":"NoteAddedAttribute","type":"object","required":["message"],"properties":{"message":{"type":"string"},"avatarUrl":{"type":"string"}}},"Nps":{"title":"Nps","type":"object","required":["value"],"properties":{"value":{"description":"Numeric value between 0 and 10 representing the net promoter score.","type":"integer","format":"int32"}}},"Open":{"title":"Open","type":"object"},"Open1":{"title":"Open","type":"object"},"OrderCanceled":{"title":"OrderCanceled","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"reason":{"type":"string"}}},"OrderCreated":{"title":"OrderCreated","type":"object","required":["orderId","total"],"properties":{"orderId":{"description":"External order ID","type":"string"},"total":{"$ref":"#/components/schemas/Money","description":"Total amount of the order, inclusive of tax and discounts"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}}}},"OrderDelivered":{"title":"OrderDelivered","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"fulfillmentId":{"description":"External fulfillment ID — links back to the fulfillment","type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}},"OrderDrafted":{"title":"OrderDrafted","type":"object","required":["orderId","total"],"properties":{"orderId":{"description":"External draft order ID","type":"string"},"total":{"$ref":"#/components/schemas/Money","description":"Total amount of the draft order, inclusive of tax and discounts"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"note":{"description":"Staff note or reason for the draft","type":"string"}}},"OrderFulfilled":{"title":"OrderFulfilled","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"fulfillmentId":{"description":"External fulfillment ID — useful for partial fulfillments","type":"string"},"trackingNumber":{"type":"string"},"trackingUrl":{"type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}},"OrganizationDetails":{"title":"OrganizationDetails","type":"object","required":["id","name","subdomain","status"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"subdomain":{"type":"string"},"status":{"description":"values: [Active, Suspended]","type":"string"},"avatarUrl":{"type":"string"}}},"Outbound":{"title":"Outbound","type":"object","required":["agentId"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"agentId":{"type":"string","format":"uuid"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"integrationEmail":{"type":"string"},"externalId":{"type":"string"},"cc":{"type":"array","items":{"type":"string","format":"uuid"}},"bcc":{"type":"array","items":{"type":"string","format":"uuid"}}}},"OutboundImport":{"title":"OutboundImport","type":"object","required":["content","agentId","createdAt"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"agentId":{"type":"string","format":"uuid"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"externalId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"attributes":{"description":"A set of dynamic attributes that are specific to the conversation channel, but not limited to it. See channel specific examples for your use case."}}},"PageRequest":{"title":"PageRequest","description":"The page to fetch. If not provided, the first page is returned","type":"object","properties":{"pageKey":{"description":"The key of the page to fetch, taken from `meta.next` or `meta.previous` in a previous response","type":"string"},"pageLimit":{"description":"The number of rows per page, up to 200","default":50,"type":"integer","format":"int32","minimum":1,"maximum":200}}},"PageResponse":{"title":"PageResponse","description":"The keys of the previous and next pages, and the page size","type":"object","required":["pageLimit"],"properties":{"previous":{"description":"The key of the previous page. Not set on the first page","type":"string"},"next":{"description":"The key of the next page. Not set on the last page","type":"string"},"pageLimit":{"description":"The page size used","type":"integer","format":"int32"}}},"PaginationLinks":{"title":"PaginationLinks","type":"object","properties":{"previous":{"description":"url","type":"string"},"next":{"description":"url","type":"string"}}},"PartialError":{"title":"PartialError","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"PatchAgentInput":{"title":"PatchAgentInput","type":"object","properties":{"displayName":{"description":"The agent's display name","type":"string"},"phoneNumber":{"description":"The agent's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The agent's first name","type":"string"},"lastName":{"description":"The agent's last name","type":"string"},"middleNames":{"description":"The agent's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the agent's avatar","type":"string"}}},"PatchConversationCustomAttributesOutput":{"title":"PatchConversationCustomAttributesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}}}},"PatchEndUserCustomAttributesOutput":{"title":"PatchEndUserCustomAttributesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}}}},"PatchEndUserInput":{"title":"PatchEndUserInput","type":"object","properties":{"displayName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"additionalEmails":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"middleNames":{"type":"array","items":{"type":"string"}},"avatarUrl":{"type":"string"},"externalId":{"type":"string"}}},"PatchEndUserOutput":{"title":"PatchEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}},"PatchWebhookSubscriptionInput":{"title":"PatchWebhookSubscriptionInput","type":"object","properties":{"name":{"description":"The Webhook Subscription name","type":"string"},"events":{"description":"The set of events this Webhook Subscription subscribes to. Allowed values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","type":"array","uniqueItems":true,"items":{"description":"values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","type":"string"}},"url":{"description":"URL of the server that the webhook request should be sent to","type":"string"},"authorization":{"$ref":"#/components/schemas/WebhookAuthorization"},"customHeaders":{"$ref":"#/components/schemas/Map_String","description":"Custom headers that will be added to the webhook request"},"enabled":{"description":"Defines whether this Webhook Subscription is enabled or disabled","type":"boolean"},"filters":{"$ref":"#/components/schemas/Map_WebhookEventType_Filters","description":"Filters to be applied to the events of the Webhook Subscription, only filtered events will be sent out. Filters can target a conversation channel, queue..."}}},"PatchWebhookSubscriptionOutput":{"title":"PatchWebhookSubscriptionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}},"Period":{"title":"Period","description":"A period, given as either a preset, `{\"preset\": \"Last7Days\"}`, or an interval, `{\"interval\": {\"from\": \"2026-06-01T00:00:00Z\", \"to\": \"2026-06-30T23:59:59.999Z\"}}`","oneOf":[{"$ref":"#/components/schemas/IntervalPeriod"},{"$ref":"#/components/schemas/PresetPeriod"}]},"PeriodFilter":{"title":"PeriodFilter","oneOf":[{"$ref":"#/components/schemas/Interval"},{"$ref":"#/components/schemas/Preset"}]},"Phone":{"title":"Phone","type":"object","required":["value"],"properties":{"value":{"description":"Phone number in E.164 format","type":"string"}}},"PhoneAttributes":{"title":"PhoneAttributes","type":"object","required":["from","to"],"properties":{"from":{"type":"string"},"to":{"type":"string"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"duration":{"type":"integer","format":"int32"}}},"PresenceDuration":{"title":"PresenceDuration","type":"object","required":["value","status"],"properties":{"value":{"type":"number","format":"double"},"status":{"$ref":"#/components/schemas/Status"}}},"Preset":{"title":"Preset","type":"object","required":["value"],"properties":{"value":{"description":"values: [PreviousQuarter, ThisWeek, PreviousWeek, Yesterday, Today, ThisMonth, PreviousMonth, ThisQuarter, ThisYear]","type":"string"}}},"PresetPeriod":{"title":"PresetPeriod","description":"A preset period, evaluated in the timezone of the query","type":"object","required":["preset"],"properties":{"preset":{"description":"The preset. The available presets are:\n\n- `Today` and `Yesterday`\n- `Last{Unit}` or `Previous{Unit}`: the previous full unit, e.g. `PreviousWeek`\n- `Last{N}{Unit}s`: for N of 2 or more, the last N units, including the current one, e.g. `Last7Days`. With N of 1 it is the same as `Previous{Unit}`\n- `This{Unit}`: the current unit so far, for `Week`, `Month`, `Quarter` or `Year`, e.g. `ThisMonth`\n\nThe units are `Hour`, `Day`, `Week`, `Month`, `Quarter` and `Year`","type":"string"}}},"PrimitiveField":{"title":"PrimitiveField","oneOf":[{"$ref":"#/components/schemas/BooleanField"},{"$ref":"#/components/schemas/DoubleField"},{"$ref":"#/components/schemas/InstantField"},{"$ref":"#/components/schemas/IntField"},{"$ref":"#/components/schemas/LongField"},{"$ref":"#/components/schemas/StringField"},{"$ref":"#/components/schemas/UUIDField"}]},"PstnPhoneConversation":{"title":"PstnPhoneConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"Query":{"title":"Query","type":"object","required":["value"],"properties":{"value":{"type":"string"},"exactMatch":{"type":"boolean"}}},"Queue":{"title":"Queue","type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"},"queuedAt":{"type":"string","format":"date-time"}}},"Queue1":{"title":"Queue","type":"object","required":["id","name","isDefault","organizationId","queueThresholds","slaCalculationMethod","doNotOfferTimeouts","isDoNotOfferEnabled"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"isDefault":{"type":"boolean"},"organizationId":{"type":"string"},"queueThresholds":{"$ref":"#/components/schemas/Map_QueueThreshold_Int"},"slaCalculationMethod":{"description":"values: [AbandonedIgnored]","type":"string"},"offerTimeout":{"type":"integer","format":"int32"},"offeringAlgorithm":{"description":"values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]","type":"string"},"memberListType":{"description":"values: [Default, SkillBased]","type":"string"},"usages":{"$ref":"#/components/schemas/QueueUsages"},"wrapupTimeout":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"offerAbandonedConversations":{"type":"boolean"},"doNotOfferTimeouts":{"$ref":"#/components/schemas/Map_ConversationChannel_Int"},"isDoNotOfferEnabled":{"type":"boolean"},"isPreferredAgentEnabled":{"type":"boolean"},"preferredAgentTimeouts":{"$ref":"#/components/schemas/Map_ConversationChannel_Int"},"preferredAgentOfflineTimeout":{"type":"integer","format":"int32"},"personalAgentOfflineTimeout":{"type":"integer","format":"int32"},"isRestricted":{"type":"boolean"}}},"QueueAvailabilityOutput":{"title":"QueueAvailabilityOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ChannelAvailabilityOutcome"}}}},"QueueId":{"title":"QueueId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldCanHaveSingleValueOrBeEmptyOperator"}}},"QueueMember":{"title":"QueueMember","type":"object","required":["agentId"],"properties":{"agentId":{"type":"string"},"priority":{"type":"integer","format":"int32"}}},"QueueMembersOutput":{"title":"QueueMembersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QueueMember"}}}},"QueueUsages":{"title":"QueueUsages","type":"object","required":["queueId","usages"],"properties":{"queueId":{"type":"string"},"usages":{"$ref":"#/components/schemas/Map_ConversationChannel_Set_String"}}},"QueuedConversation":{"title":"QueuedConversation","type":"object","required":["queuedAt"],"properties":{"position":{"description":"Approximate position of the conversation in the current queue","type":"integer","format":"int32"},"queuedAt":{"type":"string","format":"date-time"}}},"QuickResponse":{"title":"QuickResponse","type":"object","required":["id","name","content","createdBy","createdAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"content":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"string"},"lastEditedBy":{"type":"string"},"lastEditedAt":{"type":"string"},"translations":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/Translation"}},"subject":{"type":"string"}}},"RatingOffer":{"title":"RatingOffer","type":"object","required":["id","userId","agentId","ratingType"],"properties":{"id":{"type":"string"},"userId":{"type":"string"},"agentId":{"type":"string"},"ratingType":{"description":"values: [Csat, Nps, ThumbsUpOrDown]","type":"string"},"offeredAt":{"type":"string","format":"date-time"}}},"RatingResult":{"title":"RatingResult","type":"object","required":["ratingId","ratingResult"],"properties":{"ratingId":{"type":"string"},"userId":{"type":"string"},"ratingResult":{"$ref":"#/components/schemas/SubmittedRatingResult"},"comment":{"type":"string"},"submittedAt":{"type":"string","format":"date-time"}}},"RecordCatalogueEntry":{"title":"RecordCatalogueEntry","description":"A record and how to query it","type":"object","required":["id","name","category","description","deprecated"],"properties":{"id":{"description":"The record id, used in the URL when you query the record","type":"string"},"name":{"description":"The display name","type":"string"},"category":{"description":"`conversations`, `agents` or `aiagents`. Decides which endpoint you query the record with","type":"string"},"description":{"description":"A short description of the record","type":"string"},"deprecated":{"description":"Whether the record will be removed. A deprecated record can still be queried","type":"boolean"},"primaryFilters":{"description":"The keys the `primaryFilter` of a query supports: `period`, `conversationIds` or both","type":"array","items":{"type":"string"}},"filters":{"description":"The filters the record supports","type":"array","items":{"$ref":"#/components/schemas/FilterDescriptor"}},"fields":{"description":"The columns a row can contain. A nullable column can be left out of a row","type":"array","items":{"$ref":"#/components/schemas/RecordField"}},"relatedMetricIds":{"description":"The metrics based on the record","type":"array","items":{"type":"string"}}}},"RecordField":{"title":"RecordField","description":"A column of a record row","type":"object","required":["name","type","nullable","description"],"properties":{"name":{"description":"The key of the column in a row","type":"string"},"type":{"description":"The type of the column value","type":"string","enum":["String","Integer","Number","Boolean","Uuid","Timestamp","Entity","List","Object"]},"nullable":{"description":"Whether the column can be left out of a row","type":"boolean"},"description":{"description":"A description of the column","type":"string"},"unit":{"description":"The unit of the value, such as milliseconds. Not set when the value has no unit","type":"string"},"idType":{"description":"The id type. Only set when the column is a reference","type":"string","enum":["Uuid","String","Integer"]},"items":{"$ref":"#/components/schemas/RecordFieldItems"}}},"RecordFieldItems":{"title":"RecordFieldItems","description":"The type of the list items. Only set for list fields","type":"object","required":["type"],"properties":{"type":{"description":"The item type","type":"string","enum":["String","Integer","Number","Boolean","Uuid","Timestamp","Entity","List","Object"]},"idType":{"description":"The id type. Only set when the items are references","type":"string","enum":["Uuid","String","Integer"]}}},"Recurring":{"title":"Recurring","type":"object","properties":{"dayOfMonth":{"type":"integer","format":"int32"},"monthOfYear":{"type":"integer","format":"int32"},"holiday":{"type":"string"}}},"Recurring1":{"title":"Recurring","type":"object","properties":{"dayOfMonth":{"type":"integer","format":"int32"},"monthOfYear":{"type":"integer","format":"int32"},"holiday":{"type":"string"}}},"RefundCreated":{"title":"RefundCreated","type":"object","required":["orderId","total"],"properties":{"orderId":{"description":"External order ID","type":"string"},"refundId":{"description":"External refund ID — useful for idempotency on partial refunds","type":"string"},"total":{"$ref":"#/components/schemas/Money","description":"Total refund amount, inclusive of tax and discounts"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}}}},"Regular":{"title":"Regular","type":"object","required":["content"],"properties":{"content":{"$ref":"#/components/schemas/Content"}}},"Regular1":{"title":"Regular","type":"object"},"Regular2":{"title":"Regular","type":"object"},"ReopenConversationInput":{"title":"ReopenConversationInput","type":"object","properties":{"userId":{"description":"An optional agent/admin/AI agent to reopen the conversation. If not provided, the System User will be used.","type":"string","format":"uuid"}}},"Restrictions":{"title":"Restrictions","type":"object","required":["isRestricted"],"properties":{"isRestricted":{"description":"Whether a restriction is set directly on this item. The only restriction is internal use: the content is available only to logged-in users","type":"boolean"},"inheritedRestrictions":{"description":"Restrictions inherited from parent collections or categories. When several parents have the same restriction, only the top-most parent is listed","type":"array","items":{"$ref":"#/components/schemas/InheritedRestriction"}}}},"ReturnReceived":{"title":"ReturnReceived","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"returnId":{"description":"External return ID — links back to the return request","type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}},"ReturnRequested":{"title":"ReturnRequested","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"returnId":{"description":"External return ID","type":"string"},"reason":{"description":"Reason for the return","type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}},"SearchConversationsWithFiltersOutput":{"title":"SearchConversationsWithFiltersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationSearchWithFiltersHit"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"SearchField":{"title":"SearchField","oneOf":[{"$ref":"#/components/schemas/AgentId"},{"$ref":"#/components/schemas/AssignedDate"},{"$ref":"#/components/schemas/Channel"},{"$ref":"#/components/schemas/ClosedDate"},{"$ref":"#/components/schemas/ContactId"},{"$ref":"#/components/schemas/ConversationId"},{"$ref":"#/components/schemas/CreationDate"},{"$ref":"#/components/schemas/CustomAttribute1"},{"$ref":"#/components/schemas/Direction"},{"$ref":"#/components/schemas/Duration"},{"$ref":"#/components/schemas/LastActivity"},{"$ref":"#/components/schemas/LastMessage"},{"$ref":"#/components/schemas/QueueId"},{"$ref":"#/components/schemas/Status1"},{"$ref":"#/components/schemas/TagId"}]},"SearchOutput":{"title":"SearchOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationSearchHit"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}},"SearchParametersInput":{"title":"SearchParametersInput","type":"object","properties":{"query":{"$ref":"#/components/schemas/Query"},"filters":{"$ref":"#/components/schemas/Filters"}}},"SecondaryFilter":{"title":"SecondaryFilter","description":"A filter on an attribute","type":"object","required":["attribute"],"properties":{"attribute":{"description":"The attribute to filter on, from the `filters` of the metric or record. Any other attribute is rejected","type":"string"},"values":{"description":"The values to filter on, as returned by List filter values. Send an empty list for `IsEmpty` and `IsNotEmpty`","type":"array","items":{"type":"string"}},"operator":{"description":"The operator. Defaults to the `defaultOperator` of the attribute. An operator the attribute does not support is rejected","type":"string","enum":["IsEmpty","IsNotEmpty","IsOne","IsNotOne","IsAll","GreaterThan","GreaterThanOrEqual","LessThan","LessThanOrEqual"]}}},"Select":{"title":"Select","type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}}},"Select1":{"title":"Select","type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/SelectOption"}}}},"SelectOption":{"title":"SelectOption","type":"object","required":["id","label","value","isDeactivated","orderIndex"],"properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string"},"value":{"type":"string"},"nestedOptions":{"type":"array","items":{"$ref":"#/components/schemas/SelectOption"}},"isDeactivated":{"type":"boolean"},"orderIndex":{"type":"integer","format":"int32"}}},"ServerError":{"title":"ServerError","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"ShorterThanOrEqualTo":{"title":"ShorterThanOrEqualTo","description":"In milliseconds; for example: '10800000' (3 hours)","type":"object","required":["duration"],"properties":{"duration":{"type":"integer","format":"int64"}}},"SideConversation":{"title":"SideConversation","type":"object","required":["parentId"],"properties":{"parentId":{"type":"integer","format":"int64"}}},"Since":{"title":"Since","description":"Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z' ","type":"object","required":["timestamp"],"properties":{"timestamp":{"type":"string","format":"date-time"}}},"Sms":{"title":"Sms","type":"object","required":["requesterId","contactEndpointId","message"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"contactEndpointId":{"description":"SMS enabled provisioned phone number in valid E.164 format","type":"string"},"message":{"$ref":"#/components/schemas/CreateMessageInput"}}},"SmsAttributes":{"title":"SmsAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"SmsConversation":{"title":"SmsConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"fromNumber":{"type":"string"},"toNumber":{"type":"string"},"queue":{"$ref":"#/components/schemas/Queue"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"Status":{"title":"Status","type":"object","required":["status"],"properties":{"status":{"type":"string"},"description":{"type":"string"}}},"Status1":{"title":"Status","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/StatusOperator"}}},"StatusOperator":{"title":"StatusOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf4"},{"$ref":"#/components/schemas/IsOneOf4"}]},"StringField":{"title":"StringField","type":"object","required":["value"],"properties":{"value":{"type":"string"},"label":{"type":"string"}}},"SubmittedRatingResult":{"title":"SubmittedRatingResult","oneOf":[{"$ref":"#/components/schemas/Csat"},{"$ref":"#/components/schemas/Nps"},{"$ref":"#/components/schemas/ThumbsUpOrDown"}]},"Success":{"title":"Success","type":"object","required":["channelAvailability"],"properties":{"channelAvailability":{"$ref":"#/components/schemas/ChannelAvailability"}}},"Tag":{"title":"Tag","type":"object","required":["id","name","state"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string"},"state":{"description":"values: [Active, Inactive]","type":"string"}}},"TagAddedActivityType":{"title":"TagAddedActivityType","type":"object"},"TagAddedAttribute":{"title":"TagAddedAttribute","type":"object","required":["tag"],"properties":{"tag":{"type":"string"}}},"TagConversationInput":{"title":"TagConversationInput","type":"object","required":["name"],"properties":{"name":{"type":"string"}}},"TagId":{"title":"TagId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldCanHaveMultipleValuesOrBeEmptyOperator"}}},"TagRemovedActivityType":{"title":"TagRemovedActivityType","type":"object"},"TagRemovedAttribute":{"title":"TagRemovedAttribute","type":"object","required":["tag"],"properties":{"tag":{"type":"string"}}},"TagsUpdateInput":{"title":"TagsUpdateInput","description":"Tags to add or remove","type":"object","properties":{"add":{"description":"Tag IDs to add","type":"array","items":{"type":"string"}},"remove":{"description":"Tag IDs to remove","type":"array","items":{"type":"string"}}}},"Team":{"title":"Team","type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"}}},"Team1":{"title":"Team","type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}},"TeamMember":{"title":"TeamMember","type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}},"TelephonyEndpoint":{"title":"TelephonyEndpoint","type":"object","required":["number"],"properties":{"number":{"type":"string"},"functionality":{"type":"array","items":{"description":"values: [Sms, VoiceInbound, VoiceOutbound]","type":"string"}},"name":{"type":"string"}}},"Template":{"title":"Template","oneOf":[{"$ref":"#/components/schemas/EmailAutoReply"},{"$ref":"#/components/schemas/QuickResponse"}]},"TemplateInput":{"title":"TemplateInput","type":"object","required":["templateId"],"properties":{"templateId":{"type":"string","format":"uuid"},"templateVariableMap":{"$ref":"#/components/schemas/Map_String","description":"Values for the template's placeholders (e.g. {\"1\": \"John\"}). Omit for a template whose body has no placeholders; otherwise every placeholder the template declares must be supplied."}}},"TemplateTypeInput":{"title":"TemplateTypeInput","description":"Template body and type; use Text for text-only messages, Media for messages with an attachment","oneOf":[{"$ref":"#/components/schemas/Media"},{"$ref":"#/components/schemas/Text3"}]},"Text":{"title":"Text","type":"object","required":["value"],"properties":{"value":{"type":"string"}}},"Text1":{"title":"Text","type":"object","required":["value"],"properties":{"value":{"type":"string"}}},"Text2":{"title":"Text","type":"object","properties":{"placeholder":{"type":"string"}}},"Text3":{"title":"Text","type":"object","required":["body"],"properties":{"body":{"description":"Template body text; maximum 1024 characters","type":"string"}}},"ThumbsUpOrDown":{"title":"ThumbsUpOrDown","type":"object","required":["value"],"properties":{"value":{"description":"One of the the numeric values 0 (thumbs down) and 1 (thumbs up).","type":"integer","format":"int32"}}},"TimeInterval":{"title":"TimeInterval","type":"object","required":["startTime","endTime"],"properties":{"startTime":{"type":"string"},"endTime":{"type":"string"}}},"TimeInterval1":{"title":"TimeInterval","type":"object","required":["startTime","endTime"],"properties":{"startTime":{"type":"string"},"endTime":{"type":"string"}}},"TimestampField":{"title":"TimestampField","type":"object","required":["name","timestamp"],"properties":{"name":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}},"TimestampOperator":{"title":"TimestampOperator","oneOf":[{"$ref":"#/components/schemas/Between"},{"$ref":"#/components/schemas/Since"},{"$ref":"#/components/schemas/Until"}]},"TokenAuth":{"title":"TokenAuth","type":"object","required":["value"],"properties":{"value":{"description":"Token value. It will be added in the headers of the request as: 'Authorization': 'Bearer \\<value\\>'","type":"string"}}},"TooLarge":{"title":"TooLarge","type":"object","required":["file"],"properties":{"file":{"$ref":"#/components/schemas/File"}}},"TranscriptAttributes":{"title":"TranscriptAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"utterance_start_ms":{"type":"integer","format":"int64"},"utterance_end_ms":{"type":"integer","format":"int64"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"}}},"TransferConversationInput":{"title":"TransferConversationInput","type":"object","required":["queueId"],"properties":{"queueId":{"description":"The target queue for the conversation transfer","type":"string","format":"uuid"},"userId":{"description":"An optional agent/admin/AI agent to originate the transfer of the conversation. If not provided, the System User will be used.","type":"string","format":"uuid"}}},"TransferFailedActivityType":{"title":"TransferFailedActivityType","type":"object"},"TransferInitiatedActivityType":{"title":"TransferInitiatedActivityType","type":"object"},"TransferSuccessfulActivityType":{"title":"TransferSuccessfulActivityType","type":"object"},"Translation":{"title":"Translation","type":"object","required":["locale","content","isDeactivated"],"properties":{"locale":{"description":"Format for locale is {language}-{script}-{country}, e.g. \"en-US\", \"uz-Arab-AF\", \"da\"","type":"string"},"content":{"type":"string"},"isDeactivated":{"type":"boolean"},"subject":{"type":"string"}}},"Translation1":{"title":"Translation","type":"object","required":["draft"],"properties":{"draft":{"$ref":"#/components/schemas/ArticleTranslation"},"published":{"$ref":"#/components/schemas/ArticleTranslation"}}},"TranslationError":{"title":"TranslationError","type":"object","required":["languageId","message"],"properties":{"languageId":{"description":"Language code of the failed translation","type":"string"},"message":{"description":"Error message describing the failure","type":"string"}}},"TranslationInput":{"title":"TranslationInput","type":"object","required":["languageId","title"],"properties":{"languageId":{"description":"ISO language code (e.g. en, da, de)","type":"string"},"title":{"description":"Title of the translation","type":"string"},"content":{"description":"HTML content of the translation","type":"string"}}},"TranslationInput1":{"title":"TranslationInput","type":"object","required":["languageId","title"],"properties":{"languageId":{"description":"ISO language code (e.g. en, da, de)","type":"string"},"title":{"description":"Title of the translation","type":"string"},"content":{"description":"HTML content of the translation","type":"string"}}},"TranslationList":{"title":"TranslationList","type":"object","properties":{"draft":{"type":"array","items":{"$ref":"#/components/schemas/ArticleTranslation"}},"published":{"type":"array","items":{"$ref":"#/components/schemas/ArticleTranslation"}}}},"TranslationTitle":{"title":"TranslationTitle","type":"object","required":["languageId","title"],"properties":{"languageId":{"type":"string"},"title":{"type":"string"}}},"TwitterAttributes":{"title":"TwitterAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"TwitterConversation":{"title":"TwitterConversation","type":"object","required":["id","requesterId","channel","createdAt","conversationType"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"conversationType":{"description":"values: [DirectMessage, Tweet]","type":"string"},"contactPointTwitterId":{"type":"string"},"endUserTwitterId":{"type":"string"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"UUIDField":{"title":"UUIDField","type":"object","required":["value"],"properties":{"value":{"type":"string","format":"uuid"},"label":{"type":"string"}}},"Unauthorized":{"title":"Unauthorized","type":"object","required":["message"],"properties":{"message":{"type":"string"}}},"UnexpectedError":{"title":"UnexpectedError","type":"object","required":["channel","message"],"properties":{"channel":{"type":"string"},"message":{"type":"string"}}},"UnknownActivityType":{"title":"UnknownActivityType","type":"object"},"UnknownAnonymizationType":{"title":"UnknownAnonymizationType","type":"object"},"Until":{"title":"Until","description":"Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z' ","type":"object","required":["timestamp"],"properties":{"timestamp":{"type":"string","format":"date-time"}}},"UpdateAgentInput":{"title":"UpdateAgentInput","type":"object","required":["displayName"],"properties":{"displayName":{"description":"The agent's display name","type":"string"},"phoneNumber":{"description":"The agent's primary phone number","type":"string"},"additionalEmails":{"description":"Additional email addresses for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"description":"Additional phone numbers for the agent","type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"description":"The agent's first name","type":"string"},"lastName":{"description":"The agent's last name","type":"string"},"middleNames":{"description":"The agent's middle names","type":"array","items":{"type":"string"}},"avatarUrl":{"description":"The url from which to load the agent's avatar","type":"string"}}},"UpdateAgentPresenceChannelInput":{"title":"UpdateAgentPresenceChannelInput","type":"object","required":["channel","working"],"properties":{"channel":{"description":"values: [Email, InteractiveChat, Messaging, Speak]","type":"string"},"working":{"type":"boolean"}}},"UpdateEndUserInput":{"title":"UpdateEndUserInput","type":"object","required":["displayName"],"properties":{"displayName":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"},"additionalEmails":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"additionalPhoneNumbers":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"firstName":{"type":"string"},"lastName":{"type":"string"},"middleNames":{"type":"array","items":{"type":"string"}},"avatarUrl":{"type":"string"},"externalId":{"type":"string"}}},"UpdateEndUserOutput":{"title":"UpdateEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}},"UpdateKnowledgeArticleInput":{"title":"UpdateKnowledgeArticleInput","type":"object","properties":{"ownedBy":{"description":"ID of the user who owns the article","type":"string"},"tags":{"$ref":"#/components/schemas/TagsUpdateInput"},"preRelease":{"description":"Whether the article is only available in pre-release mode","type":"boolean"}}},"UpdateKnowledgeArticleOutput":{"title":"UpdateKnowledgeArticleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Article","description":"The updated article"}}},"UpdateTranslationsInput":{"title":"UpdateTranslationsInput","type":"object","properties":{"translations":{"description":"List of translations to create or update","type":"array","items":{"$ref":"#/components/schemas/TranslationInput1"}}}},"UpdateTranslationsOutput":{"title":"UpdateTranslationsOutput","type":"object","properties":{"data":{"description":"Successfully upserted translations","type":"array","items":{"$ref":"#/components/schemas/ArticleTranslation"}},"partialErrors":{"description":"Errors for translations that failed","type":"array","items":{"$ref":"#/components/schemas/TranslationError"}}}},"UploadAttachmentsInput":{"title":"UploadAttachmentsInput","type":"object","properties":{"files":{"description":"One or more image files to upload as article attachments. Each part must be a supported image format.","type":"array","items":{"type":"string","format":"binary"}}}},"UploadAttachmentsOutput":{"title":"UploadAttachmentsOutput","type":"object","properties":{"data":{"description":"Successfully uploaded attachments","type":"array","items":{"$ref":"#/components/schemas/AttachmentResult"}},"partialErrors":{"description":"Errors for attachments that failed","type":"array","items":{"$ref":"#/components/schemas/AttachmentError"}}}},"UserAnonymizationType":{"title":"UserAnonymizationType","type":"object"},"UserPresence":{"title":"UserPresence","type":"object","required":["userId","requestTime","connectionStatus"],"properties":{"userId":{"type":"string"},"requestTime":{"type":"string"},"lastSeen":{"type":"string"},"presenceStatus":{"description":"values: [Away, Working]","type":"string"},"connectionStatus":{"description":"values: [Offline, Online]","type":"string"},"activeChannels":{"type":"array","items":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"}}}},"UserPresenceOutput":{"title":"UserPresenceOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserPresence"}}},"UserReference":{"title":"UserReference","oneOf":[{"$ref":"#/components/schemas/ByContactPoints"},{"$ref":"#/components/schemas/ById"}]},"Validation":{"title":"Validation","type":"object","required":["message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}},"WebhookAuthorization":{"title":"WebhookAuthorization","description":"Authorization to be added as a header in the webhook request. Can be either, Basic auth, added as 'Basic base64encoded(\\<username\\>:\\<password\\>)', Token auth, added as 'Bearer \\<token value\\>', or no auth","oneOf":[{"$ref":"#/components/schemas/BasicAuth"},{"$ref":"#/components/schemas/NoAuth"},{"$ref":"#/components/schemas/TokenAuth"}]},"WebhookSubscription":{"title":"WebhookSubscription","type":"object","required":["id","name","url","headers","secretKey","enabled","createdAt","createdBy","updatedAt","updatedBy"],"properties":{"id":{"description":"The Webhook Subscription ID","type":"string","format":"uuid"},"name":{"description":"The Webhook Subscription name","type":"string"},"subscribedEvents":{"description":"The set of events this Webhook Subscription is subscribed to","type":"array","uniqueItems":true,"items":{"description":"values: [SLAEvaluationVoided, ConversationPending, SLAEvaluationBreached, ConversationMessageAdded, ConversationCustomAttributeUpdated, ConversationTranscriptionAdded, SLAEvaluationAchieved, ConversationAssigned, ConversationMessageDeliveryDelivered, ConversationMessageDeliveryInfo, ConversationTransferred, ConversationEnqueued, AgentUnbannedEnduser, TypingStarted, ConversationCreated, ConversationUnassigned, ConversationOpen, ConversationAbandoned, ConversationClosed, ConversationMessageDeliveryFailed, ConversationTagAdded, ConversationNoteAdded, AgentBannedEnduser, ConversationEndUserReplaced, ConversationMessageDeliverySeen, AgentUnbannedIp, ConversationMessageDeliverySent, AgentBannedIp, ConversationTagRemoved, ConversationRated, SLAEvaluationPending, ConversationMessageDeliverySpamComplaint, ConversationPendingExpired]","type":"string"}},"url":{"description":"URL of the server that the webhook request should be sent to","type":"string"},"headers":{"$ref":"#/components/schemas/Webhook_Headers_Map_String_String"},"secretKey":{"description":"Dixa generated secret key, used to sign the requests","type":"string"},"enabled":{"description":"Defines whether this Webhook Subscription is enabled or disabled","type":"boolean"},"createdAt":{"description":"Date when this Webhook Subscription was created","type":"string","format":"date-time"},"createdBy":{"description":"The ID of the user who created this Webhook Subscription","type":"string","format":"uuid"},"updatedAt":{"description":"Date when this Webhook Subscription was last updated","type":"string","format":"date-time"},"updatedBy":{"description":"The ID of the user who last updated this Webhook Subscription","type":"string","format":"uuid"},"filters":{"$ref":"#/components/schemas/Map_WebhookEventType_Filters","description":"Filters to be applied to the events that are sent to this Webhook Subscription"}}},"Webhook_Headers_Map_String_String":{"title":"Webhook_Headers_Map_String_String","description":"The headers that will be added to the webhook request","type":"object","additionalProperties":{"type":"string"}},"WhatsAppAttributes":{"title":"WhatsAppAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}},"WhatsAppConversation":{"title":"WhatsAppConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]","type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":"values: [Inbound, Internal, Outbound]","type":"string"},"state":{"description":"values: [AwaitingPending, Closed, Open, Pending]","type":"string"},"stateUpdatedAt":{"type":"string","format":"date-time"},"assignment":{"$ref":"#/components/schemas/Assignment"},"queue":{"$ref":"#/components/schemas/Queue"},"link":{"$ref":"#/components/schemas/ConversationLink"},"customAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}},"transportExpiresAt":{"type":"string","format":"date-time"}}},"Whatsapp":{"title":"Whatsapp","type":"object","required":["requesterId","contactEndpointId","message"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"contactEndpointId":{"description":"WhatsApp-enabled integration phone number that sends the message","type":"string"},"message":{"$ref":"#/components/schemas/WhatsappOutboundMessage"}}},"WhatsappOutboundMessage":{"title":"WhatsappOutboundMessage","type":"object","required":["agentId","template"],"properties":{"agentId":{"type":"string","format":"uuid"},"template":{"$ref":"#/components/schemas/TemplateInput"}}},"WhatsappTemplate":{"title":"WhatsappTemplate","type":"object","required":["id","name","language","createdAt","body","variables"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"createdAt":{"type":"string"},"category":{"type":"string"},"approvalStatus":{"type":"string"},"body":{"type":"string"},"variables":{"$ref":"#/components/schemas/Map_String"}}},"WhatsappTemplateListItem":{"title":"WhatsappTemplateListItem","type":"object","required":["id","name","language","createdAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"createdAt":{"type":"string"}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"Authorization","in":"header"}}},"security":[{"ApiKeyAuth":[]}]}