{"items":[{"type":"link","label":"Dixa API","link":"/openapi/dixa-api/beta","routeSlug":"/openapi/dixa-api/beta","content":{"contentType":"overview","meta":{"name":"Dixa API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/openapi/dixa-api/@beta/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/openapi/dixa-api/@beta/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://dev.dixa.io"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Dixa API (beta)","showPageActions":true}],"sectionId":"/openapi/dixa-api/beta"}]}]}},{"type":"group","label":"Analytics","link":"/openapi/dixa-api/beta/analytics","routeSlug":"/openapi/dixa-api/beta/analytics","items":[{"label":"Metrics Catalogue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsmetrics","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsmetrics","metadata":{"seo":{"title":"Metrics Catalogue","description":"This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAnalyticsMetrics","name":"Metrics Catalogue","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metrics Catalogue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint lists all available metric IDs that can be used to fetch data in Get Metric Data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1analytics~1metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/analytics/metrics","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/analytics/metrics","href":"analytics/getanalyticsmetrics","openApiOperationId":"getAnalyticsMetrics","summary":"Metrics Catalogue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The catalogue of metrics","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricsOutput","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetMetricsOutput","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricsOutput","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricsOutput","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/getanalyticsmetrics"}],"panels":[]}]},"httpPath":"/beta/analytics/metrics"},{"label":"Get Metric Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/postanalyticsmetrics","routeSlug":"/openapi/dixa-api/beta/analytics/postanalyticsmetrics","metadata":{"seo":{"title":"Get Metric Data","description":"Get data of a specific metric (aggregated)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAnalyticsMetrics","name":"Get Metric Data","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Metric Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get data of a specific metric (aggregated)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetMetricDataInput","exampleIds":["paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1"]}},"schemaId":"components/schemas/GetMetricDataInput","exampleIds":["paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1"],"pointer":"/paths/~1beta~1analytics~1metrics/post/requestBody","description":"The available request filters and aggregations for fetching the metric data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/analytics/metrics","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetMetricDataInput","exampleIds":["paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1"]}},"responseCodes":["200","400","500"],"pointer":"/beta/analytics/metrics","href":"analytics/postanalyticsmetrics","openApiOperationId":"postAnalyticsMetrics","summary":"Get Metric Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/GetMetricDataInput","exampleIds":["paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetMetricDataInput","exampleIds":["paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The metric data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricDataOutput","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetMetricDataOutput","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricDataOutput","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricDataOutput","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/postanalyticsmetrics"}],"panels":[]}]},"httpPath":"/beta/analytics/metrics"},{"label":"Metric Description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsmetricsmetricid","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsmetricsmetricid","metadata":{"seo":{"title":"Metric Description","description":"This endpoint lists all available properties of a metric to use for querying its data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAnalyticsMetricsMetricid","name":"Metric Description","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1metrics~1{metricId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metric Description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint lists all available properties of a metric to use for querying its data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"metricId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1analytics~1metrics~1{metricId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/analytics/metrics/{metricId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"metricId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/analytics/metrics/{metricId}","href":"analytics/getanalyticsmetricsmetricid","openApiOperationId":"getAnalyticsMetricsMetricid","summary":"Metric Description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The metric properties","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricOutput","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetMetricOutput","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1metrics~1{metricId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricOutput","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricOutput","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/getanalyticsmetricsmetricid"}],"panels":[]}]},"httpPath":"/beta/analytics/metrics/{metricId}"},{"label":"Filter values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsfilterfilterattribute","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsfilterfilterattribute","metadata":{"seo":{"title":"Filter values","description":"Get possible values to be used with a given filter attribute. Filter attributes are not metric or record specific, so one filter attribute can be used with multiple metrics/records. When a filter value is not relevant for a specific metric/record, it is simply ignored."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAnalyticsFilterFilterattribute","name":"Filter values","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1filter~1{filterAttribute}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Filter values","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filterAttribute","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1analytics~1filter~1{filterAttribute}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1analytics~1filter~1{filterAttribute}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/analytics/filter/{filterAttribute}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"filterAttribute","in":"path","required":true,"schemaId":"schema_75"}],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/analytics/filter/{filterAttribute}","href":"analytics/getanalyticsfilterfilterattribute","openApiOperationId":"getAnalyticsFilterFilterattribute","summary":"Filter values"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The possible filter values to be used when fetching metrics or records","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFilterValuesOutput","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetFilterValuesOutput","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetFilterValuesOutput","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetFilterValuesOutput","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/getanalyticsfilterfilterattribute"}],"panels":[]}]},"httpPath":"/beta/analytics/filter/{filterAttribute}"},{"label":"Metric Records Catalogue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsrecords","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsrecords","metadata":{"seo":{"title":"Metric Records Catalogue","description":"This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAnalyticsRecords","name":"Metric Records Catalogue","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1records/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metric Records Catalogue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint lists all available record IDs that can be used to fetch data in Get Metric Records Data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1analytics~1records/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/analytics/records","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/analytics/records","href":"analytics/getanalyticsrecords","openApiOperationId":"getAnalyticsRecords","summary":"Metric Records Catalogue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The catalogue of metric records","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsOutput","exampleIds":["paths/~1beta~1analytics~1records/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetMetricRecordsOutput","exampleIds":["paths/~1beta~1analytics~1records/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1records/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricRecordsOutput","exampleIds":["paths/~1beta~1analytics~1records/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsOutput","exampleIds":["paths/~1beta~1analytics~1records/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/getanalyticsrecords"}],"panels":[]}]},"httpPath":"/beta/analytics/records"},{"label":"Get Metric Records Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/postanalyticsrecords","routeSlug":"/openapi/dixa-api/beta/analytics/postanalyticsrecords","metadata":{"seo":{"title":"Get Metric Records Data","description":"Get data of specific metric records (unaggregated)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAnalyticsRecords","name":"Get Metric Records Data","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1records/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Metric Records Data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get data of specific metric records (unaggregated)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1analytics~1records/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsDataInput","exampleIds":["paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1"]}},"schemaId":"components/schemas/GetMetricRecordsDataInput","exampleIds":["paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1"],"pointer":"/paths/~1beta~1analytics~1records/post/requestBody","description":"The available request filters for fetching the metric records data"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/analytics/records","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsDataInput","exampleIds":["paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1"]}},"responseCodes":["200","400","500"],"pointer":"/beta/analytics/records","href":"analytics/postanalyticsrecords","openApiOperationId":"postAnalyticsRecords","summary":"Get Metric Records Data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/GetMetricRecordsDataInput","exampleIds":["paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsDataInput","exampleIds":["paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0","paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The metric records data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsDataOutput","exampleIds":["paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/No Value Metric Records Data Example","paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/Metric Records Data Example"]}},"schemaId":"components/schemas/GetMetricRecordsDataOutput","exampleIds":["paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/No Value Metric Records Data Example","paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/Metric Records Data Example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1records/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricRecordsDataOutput","exampleIds":["paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/No Value Metric Records Data Example","paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/Metric Records Data Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricRecordsDataOutput","exampleIds":["paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/No Value Metric Records Data Example","paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/Metric Records Data Example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/postanalyticsrecords"}],"panels":[]}]},"httpPath":"/beta/analytics/records"},{"label":"Metric Record Description","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/analytics/getanalyticsrecordsrecordid","routeSlug":"/openapi/dixa-api/beta/analytics/getanalyticsrecordsrecordid","metadata":{"seo":{"title":"Metric Record Description","description":"This endpoint lists all available properties of a record to use for querying its data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAnalyticsRecordsRecordid","name":"Metric Record Description","isWebhook":false,"pointer":"/paths/~1beta~1analytics~1records~1{recordId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Metric Record Description","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint lists all available properties of a record to use for querying its data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1analytics~1records~1{recordId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/analytics/records/{recordId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"recordId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/analytics/records/{recordId}","href":"analytics/getanalyticsrecordsrecordid","openApiOperationId":"getAnalyticsRecordsRecordid","summary":"Metric Record Description"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The metric record properties","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricRecordOutput","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetMetricRecordOutput","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1analytics~1records~1{recordId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetMetricRecordOutput","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetMetricRecordOutput","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1analytics~1records~1{recordId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/analytics/getanalyticsrecordsrecordid"}],"panels":[]}]},"httpPath":"/beta/analytics/records/{recordId}"}],"content":{"contentType":"group","meta":{"name":"Analytics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Analytics","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/analytics/metrics","summary":"Metrics Catalogue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics/getanalyticsmetrics","deprecated":false},{"title":"/beta/analytics/metrics","summary":"Get Metric Data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/analytics/postanalyticsmetrics","deprecated":false},{"title":"/beta/analytics/metrics/{metricId}","summary":"Metric Description","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics/getanalyticsmetricsmetricid","deprecated":false},{"title":"/beta/analytics/filter/{filterAttribute}","summary":"Filter values","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics/getanalyticsfilterfilterattribute","deprecated":false},{"title":"/beta/analytics/records","summary":"Metric Records Catalogue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics/getanalyticsrecords","deprecated":false},{"title":"/beta/analytics/records","summary":"Get Metric Records Data","prefix":{"name":"post","color":"post"},"badges":[],"link":"/analytics/postanalyticsrecords","deprecated":false},{"title":"/beta/analytics/records/{recordId}","summary":"Metric Record Description","prefix":{"name":"get","color":"get"},"badges":[],"link":"/analytics/getanalyticsrecordsrecordid","deprecated":false}]}]}]}]}},{"type":"group","label":"Agents","link":"/openapi/dixa-api/beta/agents","routeSlug":"/openapi/dixa-api/beta/agents","items":[{"label":"List presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentspresence","routeSlug":"/openapi/dixa-api/beta/agents/getagentspresence","metadata":{"seo":{"title":"List presence","description":"List the presence status for all agents/admins in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgentsPresence","name":"List presence","isWebhook":false,"pointer":"/paths/~1beta~1agents~1presence/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List presence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the presence status for all agents/admins in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/agents/presence","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/agents/presence","href":"agents/getagentspresence","openApiOperationId":"getAgentsPresence","summary":"List presence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of presence status for all agents/admins","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1beta~1agents~1presence/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_76","exampleIds":["paths/~1beta~1agents~1presence/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1presence/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1presence/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1presence/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1presence/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1presence/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_76","exampleIds":["paths/~1beta~1agents~1presence/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1beta~1agents~1presence/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1presence/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1presence/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1presence/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1presence/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/getagentspresence"}],"panels":[]}]},"httpPath":"/beta/agents/presence"},{"label":"List agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagents","routeSlug":"/openapi/dixa-api/beta/agents/getagents","metadata":{"seo":{"title":"List agents","description":"Lists all agents/admins in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgents","name":"List agents","isWebhook":false,"pointer":"/paths/~1beta~1agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."},{"name":"email","in":"query","schemaId":"schema_75","description":"The agent/admin email filter"},{"name":"phone","in":"query","schemaId":"schema_75","description":"The agent/admin phone number filter"}],"pointer":"/paths/~1beta~1agents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"},{"name":"email","in":"query","required":false,"schemaId":"schema_75"},{"name":"phone","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/agents","href":"agents/getagents","openApiOperationId":"getAgents","summary":"List agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of agents/admins","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAgentsOutput","exampleIds":["paths/~1beta~1agents/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListAgentsOutput","exampleIds":["paths/~1beta~1agents/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAgentsOutput","exampleIds":["paths/~1beta~1agents/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAgentsOutput","exampleIds":["paths/~1beta~1agents/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/getagents"}],"panels":[]}]},"httpPath":"/beta/agents"},{"label":"Update agents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/putagents","routeSlug":"/openapi/dixa-api/beta/agents/putagents","metadata":{"seo":{"title":"Update agents","description":"Bulk update agents/admins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putAgents","name":"Update agents","isWebhook":false,"pointer":"/paths/~1beta~1agents/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Bulk update agents/admins."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_77","exampleIds":["paths/~1beta~1agents/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_77","exampleIds":["paths/~1beta~1agents/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents/put/requestBody","description":"The list of agent/admin update actions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"schema_77","exampleIds":["paths/~1beta~1agents/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/agents","href":"agents/putagents","openApiOperationId":"putAgents","summary":"Update agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"schema_77","exampleIds":["paths/~1beta~1agents/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_77","exampleIds":["paths/~1beta~1agents/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of update action outcomes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/put/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/put/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/putagents"}],"panels":[]}]},"httpPath":"/beta/agents"},{"label":"Create agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/postagents","routeSlug":"/openapi/dixa-api/beta/agents/postagents","metadata":{"seo":{"title":"Create agent","description":"Create an agent."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAgents","name":"Create agent","isWebhook":false,"pointer":"/paths/~1beta~1agents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an agent."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAgentInput","exampleIds":["paths/~1beta~1agents/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateAgentInput","exampleIds":["paths/~1beta~1agents/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents/post/requestBody","description":"The agent's details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAgentInput","exampleIds":["paths/~1beta~1agents/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/agents","href":"agents/postagents","openApiOperationId":"postAgents","summary":"Create agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateAgentInput","exampleIds":["paths/~1beta~1agents/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAgentInput","exampleIds":["paths/~1beta~1agents/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created agent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during agent creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/postagents"}],"panels":[]}]},"httpPath":"/beta/agents"},{"label":"Patch agents","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/patchagents","routeSlug":"/openapi/dixa-api/beta/agents/patchagents","metadata":{"seo":{"title":"Patch agents","description":"Bulk patch agents/admins."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAgents","name":"Patch agents","isWebhook":false,"pointer":"/paths/~1beta~1agents/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Bulk patch agents/admins."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1beta~1agents/patch/requestBody/content/application~1json/example"]}},"schemaId":"schema_78","exampleIds":["paths/~1beta~1agents/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents/patch/requestBody","description":"List of agent/admin patch actions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1beta~1agents/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/agents","href":"agents/patchagents","openApiOperationId":"patchAgents","summary":"Patch agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"schema_78","exampleIds":["paths/~1beta~1agents/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1beta~1agents/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of patch action outcomes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/patch/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUpdateAgentOutput","exampleIds":["paths/~1beta~1agents/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents/patch/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/patchagents"}],"panels":[]}]},"httpPath":"/beta/agents"},{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentsagentidteams","routeSlug":"/openapi/dixa-api/beta/agents/getagentsagentidteams","metadata":{"seo":{"title":"List teams","description":"List the teams in which the agent/admin is a member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgentsAgentidTeams","name":"List teams","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}~1teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List teams","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the teams in which the agent/admin is a member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent/admin id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}~1teams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/agents/{agentId}/teams","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/agents/{agentId}/teams","href":"agents/getagentsagentidteams","openApiOperationId":"getAgentsAgentidTeams","summary":"List teams"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of teams in which the agent/admin is a member","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentTeamsOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AgentTeamsOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter agentId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}~1teams/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentTeamsOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentTeamsOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1teams/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/getagentsagentidteams"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}/teams"},{"label":"Get presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentsagentidpresence","routeSlug":"/openapi/dixa-api/beta/agents/getagentsagentidpresence","metadata":{"seo":{"title":"Get presence","description":"Get the presence status for an agent/admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgentsAgentidPresence","name":"Get presence","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}~1presence/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get presence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the presence status for an agent/admin."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent/admin id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}~1presence/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/agents/{agentId}/presence","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/agents/{agentId}/presence","href":"agents/getagentsagentidpresence","openApiOperationId":"getAgentsAgentidPresence","summary":"Get presence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The agent/admin presence status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPresenceOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UserPresenceOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter agentId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}~1presence/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserPresenceOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserPresenceOutput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/getagentsagentidpresence"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}/presence"},{"label":"Create agents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/postagentsbulk","routeSlug":"/openapi/dixa-api/beta/agents/postagentsbulk","metadata":{"seo":{"title":"Create agents","description":"Create agents in bulk."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAgentsBulk","name":"Create agents","isWebhook":false,"pointer":"/paths/~1beta~1agents~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create agents in bulk."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAgentsInput","exampleIds":["paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateAgentsInput","exampleIds":["paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents~1bulk/post/requestBody","description":"The list of agent's details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/agents/bulk","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAgentsInput","exampleIds":["paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/agents/bulk","href":"agents/postagentsbulk","openApiOperationId":"postAgentsBulk","summary":"Create agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateAgentsInput","exampleIds":["paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAgentsInput","exampleIds":["paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created agents","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAgentsOutput","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateAgentsOutput","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateAgentsOutput","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateAgentsOutput","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1bulk/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/postagentsbulk"}],"panels":[]}]},"httpPath":"/beta/agents/bulk"},{"label":"Get agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/getagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/getagentsagentid","metadata":{"seo":{"title":"Get agent","description":"Get an agent/admin by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgentsAgentid","name":"Get agent","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an agent/admin by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent/admin id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/agents/{agentId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/agents/{agentId}","href":"agents/getagentsagentid","openApiOperationId":"getAgentsAgentid","summary":"Get agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter agentId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/getagentsagentid"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}"},{"label":"Update agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/putagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/putagentsagentid","metadata":{"seo":{"title":"Update agent","description":"Update an agent/admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putAgentsAgentid","name":"Update agent","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an agent/admin."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents~1{agentId}/put/requestBody","description":"The updated details for an agent/admin"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/agents/{agentId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/agents/{agentId}","href":"agents/putagentsagentid","openApiOperationId":"putAgentsAgentid","summary":"Update agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/UpdateAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter agentId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/putagentsagentid"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}"},{"label":"Delete agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/deleteagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/deleteagentsagentid","metadata":{"seo":{"title":"Delete agent","description":"Downgrade an agent/admin to become an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAgentsAgentid","name":"Delete agent","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Downgrade an agent/admin to become an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent/admin id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/agents/{agentId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"responseCodes":["204","400","404"],"pointer":"/beta/agents/{agentId}","href":"agents/deleteagentsagentid","openApiOperationId":"deleteAgentsAgentid","summary":"Delete agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The agent/admin was successfully downgraded to end user"},{"code":"400","description":"Invalid value for: path parameter agentId, Invalid value extracted from request context, Validation failure during delete processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/delete/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/deleteagentsagentid"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}"},{"label":"Patch agent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/patchagentsagentid","routeSlug":"/openapi/dixa-api/beta/agents/patchagentsagentid","metadata":{"seo":{"title":"Patch agent","description":"Patch an agent/admin."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAgentsAgentid","name":"Patch agent","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch an agent/admin."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent/admin id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents~1{agentId}/patch/requestBody","description":"The agent/admin patch"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/agents/{agentId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/agents/{agentId}","href":"agents/patchagentsagentid","openApiOperationId":"patchAgentsAgentid","summary":"Patch agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/PatchAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchAgentInput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter agentId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentOutput","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/patchagentsagentid"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}"},{"label":"Updates the working channel of an agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/agents/putagentsagentidpresenceworking-channel","routeSlug":"/openapi/dixa-api/beta/agents/putagentsagentidpresenceworking-channel","metadata":{"seo":{"title":"Updates the working channel of an agent","description":"Updates the working channel of an agent"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putAgentsAgentidPresenceWorking-channel","name":"Updates the working channel of an agent","isWebhook":false,"pointer":"/paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates the working channel of an agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates the working channel of an agent"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member.presence.working_media"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_79","description":"The agent id","required":true}],"pointer":"/paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAgentPresenceChannelInput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateAgentPresenceChannelInput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody","description":"The state of the agent presence channel"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/agents/{agentId}/presence/working-channel","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member.presence.working_media"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAgentPresenceChannelInput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500"],"pointer":"/beta/agents/{agentId}/presence/working-channel","href":"agents/putagentsagentidpresenceworking-channel","openApiOperationId":"putAgentsAgentidPresenceWorking-channel","summary":"Updates the working channel of an agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/UpdateAgentPresenceChannelInput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAgentPresenceChannelInput","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The working channel of the agent was successfully updated"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agents/putagentsagentidpresenceworking-channel"}],"panels":[]}]},"httpPath":"/beta/agents/{agentId}/presence/working-channel"}],"content":{"contentType":"group","meta":{"name":"Agents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agents","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/agents/presence","summary":"List presence","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agents/getagentspresence","deprecated":false},{"title":"/beta/agents","summary":"List agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agents/getagents","deprecated":false},{"title":"/beta/agents","summary":"Update agents","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agents/putagents","deprecated":false},{"title":"/beta/agents","summary":"Create agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agents/postagents","deprecated":false},{"title":"/beta/agents","summary":"Patch agents","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agents/patchagents","deprecated":false},{"title":"/beta/agents/{agentId}/teams","summary":"List teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agents/getagentsagentidteams","deprecated":false},{"title":"/beta/agents/{agentId}/presence","summary":"Get presence","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agents/getagentsagentidpresence","deprecated":false},{"title":"/beta/agents/bulk","summary":"Create agents","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agents/postagentsbulk","deprecated":false},{"title":"/beta/agents/{agentId}","summary":"Get agent","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agents/getagentsagentid","deprecated":false},{"title":"/beta/agents/{agentId}","summary":"Update agent","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agents/putagentsagentid","deprecated":false},{"title":"/beta/agents/{agentId}","summary":"Delete agent","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agents/deleteagentsagentid","deprecated":false},{"title":"/beta/agents/{agentId}","summary":"Patch agent","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agents/patchagentsagentid","deprecated":false},{"title":"/beta/agents/{agentId}/presence/working-channel","summary":"Updates the working channel of an agent","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agents/putagentsagentidpresenceworking-channel","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Agents","link":"/openapi/dixa-api/beta/ai-agents","routeSlug":"/openapi/dixa-api/beta/ai-agents","items":[{"label":"List AI agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ai-agents/getai-agents","routeSlug":"/openapi/dixa-api/beta/ai-agents/getai-agents","metadata":{"seo":{"title":"List AI agents","description":"Lists all AI agents in an organization. AI agents include Dixa's native Mim agents and external chatbot integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAi-agents","name":"List AI agents","isWebhook":false,"pointer":"/paths/~1beta~1ai-agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List AI agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all AI agents in an organization. AI agents include Dixa's native Mim agents and external chatbot integrations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/ai-agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/ai-agents","href":"ai-agents/getai-agents","openApiOperationId":"getAi-agents","summary":"List AI agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of AI agents","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAiAgentsOutput","exampleIds":["paths/~1beta~1ai-agents/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListAiAgentsOutput","exampleIds":["paths/~1beta~1ai-agents/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1ai-agents/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1ai-agents/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1ai-agents/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1ai-agents/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1ai-agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAiAgentsOutput","exampleIds":["paths/~1beta~1ai-agents/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAiAgentsOutput","exampleIds":["paths/~1beta~1ai-agents/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1ai-agents/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1ai-agents/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1ai-agents/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1ai-agents/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ai-agents/getai-agents"}],"panels":[]}]},"httpPath":"/beta/ai-agents"}],"content":{"contentType":"group","meta":{"name":"AI Agents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agents","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/ai-agents","summary":"List AI agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/getai-agents","deprecated":false}]}]}]}]}},{"type":"group","label":"End Users","link":"/openapi/dixa-api/beta/end-users","routeSlug":"/openapi/dixa-api/beta/end-users","items":[{"label":"List end users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/getendusers","routeSlug":"/openapi/dixa-api/beta/end-users/getendusers","metadata":{"seo":{"title":"List end users","description":"Lists all end users in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned. Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a user use the GET /endusers/{userId} endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEndusers","name":"List end users","isWebhook":false,"pointer":"/paths/~1beta~1endusers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List end users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Custom attributes are not part of the response at this point. If you need to get custom attributes for a user use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../End-Users/#tag/End-Users/operation/getEndusersUserid"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /endusers/{userId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."},{"name":"email","in":"query","schemaId":"schema_75","description":"Filter by the contact's email"},{"name":"phone","in":"query","schemaId":"schema_75","description":"Filter by the contact's phone number"},{"name":"externalId","in":"query","schemaId":"schema_75","description":"Filter by the contact's external id"}],"pointer":"/paths/~1beta~1endusers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/endusers","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"},{"name":"email","in":"query","required":false,"schemaId":"schema_75"},{"name":"phone","in":"query","required":false,"schemaId":"schema_75"},{"name":"externalId","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers","href":"end-users/getendusers","openApiOperationId":"getEndusers","summary":"List end users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of end users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEndUsersOutput","exampleIds":["paths/~1beta~1endusers/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListEndUsersOutput","exampleIds":["paths/~1beta~1endusers/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEndUsersOutput","exampleIds":["paths/~1beta~1endusers/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEndUsersOutput","exampleIds":["paths/~1beta~1endusers/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/getendusers"}],"panels":[]}]},"httpPath":"/beta/endusers"},{"label":"Update end users","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/putendusers","routeSlug":"/openapi/dixa-api/beta/end-users/putendusers","metadata":{"seo":{"title":"Update end users","description":"Bulk update end users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putEndusers","name":"Update end users","isWebhook":false,"pointer":"/paths/~1beta~1endusers/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update end users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Bulk update end users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkUpdateEndUsersInput","exampleIds":["paths/~1beta~1endusers/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkUpdateEndUsersInput","exampleIds":["paths/~1beta~1endusers/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers/put/requestBody","description":"List of end user update actions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/endusers","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkUpdateEndUsersInput","exampleIds":["paths/~1beta~1endusers/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/endusers","href":"end-users/putendusers","openApiOperationId":"putEndusers","summary":"Update end users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkUpdateEndUsersInput","exampleIds":["paths/~1beta~1endusers/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkUpdateEndUsersInput","exampleIds":["paths/~1beta~1endusers/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated end users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUpdateEndUsersOutput","exampleIds":["paths/~1beta~1endusers/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkUpdateEndUsersOutput","exampleIds":["paths/~1beta~1endusers/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/put/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkUpdateEndUsersOutput","exampleIds":["paths/~1beta~1endusers/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUpdateEndUsersOutput","exampleIds":["paths/~1beta~1endusers/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/put/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/putendusers"}],"panels":[]}]},"httpPath":"/beta/endusers"},{"label":"Create end user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/postendusers","routeSlug":"/openapi/dixa-api/beta/end-users/postendusers","metadata":{"seo":{"title":"Create end user","description":"Create an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postEndusers","name":"Create end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers/post/requestBody","description":"The end user's details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/endusers","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/endusers","href":"end-users/postendusers","openApiOperationId":"postEndusers","summary":"Create end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created end user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during enduser creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/postendusers"}],"panels":[]}]},"httpPath":"/beta/endusers"},{"label":"Patch end users","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusers","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusers","metadata":{"seo":{"title":"Patch end users","description":"Bulk patch end users."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEndusers","name":"Patch end users","isWebhook":false,"pointer":"/paths/~1beta~1endusers/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch end users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Bulk patch end users."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkPatchEndUsersInput","exampleIds":["paths/~1beta~1endusers/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkPatchEndUsersInput","exampleIds":["paths/~1beta~1endusers/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers/patch/requestBody","description":"List of end user patch actions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/endusers","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkPatchEndUsersInput","exampleIds":["paths/~1beta~1endusers/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/endusers","href":"end-users/patchendusers","openApiOperationId":"patchEndusers","summary":"Patch end users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkPatchEndUsersInput","exampleIds":["paths/~1beta~1endusers/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkPatchEndUsersInput","exampleIds":["paths/~1beta~1endusers/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched end users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkPatchEndUsersOutput","exampleIds":["paths/~1beta~1endusers/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkPatchEndUsersOutput","exampleIds":["paths/~1beta~1endusers/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/patch/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkPatchEndUsersOutput","exampleIds":["paths/~1beta~1endusers/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkPatchEndUsersOutput","exampleIds":["paths/~1beta~1endusers/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/patch/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/patchendusers"}],"panels":[]}]},"httpPath":"/beta/endusers"},{"label":"Create end users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/postendusersbulk","routeSlug":"/openapi/dixa-api/beta/end-users/postendusersbulk","metadata":{"seo":{"title":"Create end users","description":"Create multiple end users in a single bulk action"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postEndusersBulk","name":"Create end users","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create end users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create multiple end users in a single bulk action"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEndUsersInput","exampleIds":["paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEndUsersInput","exampleIds":["paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers~1bulk/post/requestBody","description":"The list of end user details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/endusers/bulk","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEndUsersInput","exampleIds":["paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/endusers/bulk","href":"end-users/postendusersbulk","openApiOperationId":"postEndusersBulk","summary":"Create end users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateEndUsersInput","exampleIds":["paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEndUsersInput","exampleIds":["paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created end users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEndUsersOutput","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEndUsersOutput","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEndUsersOutput","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEndUsersOutput","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1bulk/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/postendusersbulk"}],"panels":[]}]},"httpPath":"/beta/endusers/bulk"},{"label":"Get end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/getendusersuserid","routeSlug":"/openapi/dixa-api/beta/end-users/getendusersuserid","metadata":{"seo":{"title":"Get end user","description":"Get an end user by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEndusersUserid","name":"Get end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an end user by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","description":"The end user id","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/endusers/{userId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers/{userId}","href":"end-users/getendusersuserid","openApiOperationId":"getEndusersUserid","summary":"Get end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The end user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter userId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/getendusersuserid"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}"},{"label":"Update end user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/putendusersuserid","routeSlug":"/openapi/dixa-api/beta/end-users/putendusersuserid","metadata":{"seo":{"title":"Update end user","description":"Update an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putEndusersUserid","name":"Update end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","description":"The end user id","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers~1{userId}/put/requestBody","description":"The updated details for an end user"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/endusers/{userId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers/{userId}","href":"end-users/putendusersuserid","openApiOperationId":"putEndusersUserid","summary":"Update end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/UpdateEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated end user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/putendusersuserid"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}"},{"label":"Patch end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusersuserid","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusersuserid","metadata":{"seo":{"title":"Patch end user","description":"Patch an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEndusersUserid","name":"Patch end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","description":"The end user id to be patched","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers~1{userId}/patch/requestBody","description":"The end user patch"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/endusers/{userId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers/{userId}","href":"end-users/patchendusersuserid","openApiOperationId":"patchEndusersUserid","summary":"Patch end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/PatchEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchEndUserInput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched end user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Validation failure during update","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/patchendusersuserid"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}"},{"label":"Anonymize end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusersuseridanonymize","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusersuseridanonymize","metadata":{"seo":{"title":"Anonymize end user","description":"Request the anonymization of an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEndusersUseridAnonymize","name":"Anonymize end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","description":"The id of the end user to anonymize","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_80","description":"Whether to force close all the conversations initiated by the end user, if any are found in a non closed state."}],"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/endusers/{userId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"force","in":"query","required":false,"schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/endusers/{userId}/anonymize","href":"end-users/patchendusersuseridanonymize","openApiOperationId":"patchEndusersUseridAnonymize","summary":"Anonymize end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The end user's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest"}},"schemaId":"components/schemas/BadRequest"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/patchendusersuseridanonymize"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}/anonymize"},{"label":"Patch end user custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/patchendusersuseridcustom-attributes","routeSlug":"/openapi/dixa-api/beta/end-users/patchendusersuseridcustom-attributes","metadata":{"seo":{"title":"Patch end user custom attributes","description":"Patch custom attributes of an end user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEndusersUseridCustom-attributes","name":"Patch end user custom attributes","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch end user custom attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch custom attributes of an end user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["contact.custom_attribute"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/endusers/{userId}/custom-attributes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["contact.custom_attribute"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/beta/endusers/{userId}/custom-attributes","href":"end-users/patchendusersuseridcustom-attributes","openApiOperationId":"patchEndusersUseridCustom-attributes","summary":"Patch end user custom attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched end user attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/patchendusersuseridcustom-attributes"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}/custom-attributes"},{"label":"List end user conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/end-users/getendusersuseridconversations","routeSlug":"/openapi/dixa-api/beta/end-users/getendusersuseridconversations","metadata":{"seo":{"title":"List end user conversations","description":"Lists conversations requested by an end user.  Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the GET /conversations/{conversationId} endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEndusersUseridConversations","name":"List end user conversations","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List end user conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists conversations requested by an end user. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../Conversations/#tag/Conversations/operation/getConversationsConversationid"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /conversations/{conversationId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/endusers/{userId}/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers/{userId}/conversations","href":"end-users/getendusersuseridconversations","openApiOperationId":"getEndusersUseridConversations","summary":"List end user conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of conversations requested by an EndUser","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/end-users/getendusersuseridconversations"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}/conversations"}],"content":{"contentType":"group","meta":{"name":"End Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"End Users","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/endusers","summary":"List end users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/end-users/getendusers","deprecated":false},{"title":"/beta/endusers","summary":"Update end users","prefix":{"name":"put","color":"put"},"badges":[],"link":"/end-users/putendusers","deprecated":false},{"title":"/beta/endusers","summary":"Create end user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/end-users/postendusers","deprecated":false},{"title":"/beta/endusers","summary":"Patch end users","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/end-users/patchendusers","deprecated":false},{"title":"/beta/endusers/bulk","summary":"Create end users","prefix":{"name":"post","color":"post"},"badges":[],"link":"/end-users/postendusersbulk","deprecated":false},{"title":"/beta/endusers/{userId}","summary":"Get end user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/end-users/getendusersuserid","deprecated":false},{"title":"/beta/endusers/{userId}","summary":"Update end user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/end-users/putendusersuserid","deprecated":false},{"title":"/beta/endusers/{userId}","summary":"Patch end user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/end-users/patchendusersuserid","deprecated":false},{"title":"/beta/endusers/{userId}/anonymize","summary":"Anonymize end user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/end-users/patchendusersuseridanonymize","deprecated":false},{"title":"/beta/endusers/{userId}/custom-attributes","summary":"Patch end user custom attributes","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/end-users/patchendusersuseridcustom-attributes","deprecated":false},{"title":"/beta/endusers/{userId}/conversations","summary":"List end user conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/end-users/getendusersuseridconversations","deprecated":false}]}]}]}]}},{"type":"group","label":"Chatbots","link":"/openapi/dixa-api/beta/chatbots","routeSlug":"/openapi/dixa-api/beta/chatbots","items":[{"label":"Create end user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postendusers","routeSlug":"/openapi/dixa-api/beta/chatbots/postendusers","metadata":{"seo":{"title":"Create end user","description":"Create an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postEndusers","name":"Create end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.member"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers/post/requestBody","description":"The end user's details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/endusers","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.member"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/endusers","href":"chatbots/postendusers","openApiOperationId":"postEndusers","summary":"Create end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateEndUserInput","exampleIds":["paths/~1beta~1endusers/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created end user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during enduser creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateEndUserOutput","exampleIds":["paths/~1beta~1endusers/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/postendusers"}],"panels":[]}]},"httpPath":"/beta/endusers"},{"label":"Get end user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getendusersuserid","routeSlug":"/openapi/dixa-api/beta/chatbots/getendusersuserid","metadata":{"seo":{"title":"Get end user","description":"Get an end user by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEndusersUserid","name":"Get end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an end user by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","description":"The end user id","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/endusers/{userId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers/{userId}","href":"chatbots/getendusersuserid","openApiOperationId":"getEndusersUserid","summary":"Get end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The end user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter userId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetEndUserOutput","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/getendusersuserid"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}"},{"label":"List end user conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getendusersuseridconversations","routeSlug":"/openapi/dixa-api/beta/chatbots/getendusersuseridconversations","metadata":{"seo":{"title":"List end user conversations","description":"Lists conversations requested by an end user.  Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the GET /conversations/{conversationId} endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEndusersUseridConversations","name":"List end user conversations","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List end user conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists conversations requested by an end user. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../Conversations/#tag/Conversations/operation/getConversationsConversationid"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GET /conversations/{conversationId}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/endusers/{userId}/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/endusers/{userId}/conversations","href":"chatbots/getendusersuseridconversations","openApiOperationId":"getEndusersUseridConversations","summary":"List end user conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of conversations requested by an EndUser","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}~1conversations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListEndUserConversationsOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/getendusersuseridconversations"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}/conversations"},{"label":"Close conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclose","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclose","metadata":{"seo":{"title":"Close conversation","description":"Mark a conversation as closed by providing its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidClose","name":"Close conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a conversation as closed by providing its id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody","description":"An optional agent/admin to close the conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/close","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404"],"pointer":"/beta/conversations/{conversationId}/close","href":"chatbots/putconversationsconversationidclose","openApiOperationId":"putConversationsConversationidClose","summary":"Close conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully closed"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/putconversationsconversationidclose"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/close"},{"label":"Followup conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidfollowup","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidfollowup","metadata":{"seo":{"title":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidFollowup","name":"Followup conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Followup conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Follow up a conversation by providing its id and expiration timestamp."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody","description":"A request to followup the conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/followup","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404"],"pointer":"/beta/conversations/{conversationId}/followup","href":"chatbots/putconversationsconversationidfollowup","openApiOperationId":"putConversationsConversationidFollowup","summary":"Followup conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully followed up"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/putconversationsconversationidfollowup"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/followup"},{"label":"Transfer conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidtransferqueue","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidtransferqueue","metadata":{"seo":{"title":"Transfer conversation","description":"Transfer a conversation to a target queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidTransferQueue","name":"Transfer conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfer a conversation to a target queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody","description":"Transfer conversation request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/transfer/queue","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/transfer/queue","href":"chatbots/putconversationsconversationidtransferqueue","openApiOperationId":"putConversationsConversationidTransferQueue","summary":"Transfer conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully transferred to the target queue"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin, Queue does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/putconversationsconversationidtransferqueue"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/transfer/queue"},{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidRatingsRatingidSubmit","name":"Create conversation rating result","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation rating result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rating result for a specific conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.satisfaction"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"ratingId","in":"path","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ratingId parameter has to be the ID of the offer created via invoking the /conversations/{conversationId}/ratings/offer endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody","description":"The rating result to be created for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"ratingId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.satisfaction"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","href":"chatbots/postconversationsconversationidratingsratingidsubmit","openApiOperationId":"postConversationsConversationidRatingsRatingidSubmit","summary":"Create conversation rating result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created conversation rating result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/postconversationsconversationidratingsratingidsubmit"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidRatingsOffer","name":"Create conversation rating offer","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation rating offer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rating offer for a specific conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.satisfaction"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody","description":"The rating offer to be created for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/ratings/offer","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.satisfaction"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations/{conversationId}/ratings/offer","href":"chatbots/postconversationsconversationidratingsoffer","openApiOperationId":"postConversationsConversationidRatingsOffer","summary":"Create conversation rating offer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created conversation rating offer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/postconversationsconversationidratingsoffer"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings/offer"},{"label":"Create conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversations","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversations","metadata":{"seo":{"title":"Create conversation","description":"Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversations","name":"Create conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"]}},"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"],"pointer":"/paths/~1beta~1conversations/post/requestBody","description":"The conversation to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations","href":"chatbots/postconversations","openApiOperationId":"postConversations","summary":"Create conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The id of the created conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Duplicate externalId, Unsupported ConversationChannel","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/postconversations"}],"panels":[]}]},"httpPath":"/beta/conversations"},{"label":"Import conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/postconversationsimport","routeSlug":"/openapi/dixa-api/beta/chatbots/postconversationsimport","metadata":{"seo":{"title":"Import conversation","description":"Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the message author through its attributes. For outbound messages the author is specified using the agentId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsImport","name":"Import conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.import"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"]}},"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"],"pointer":"/paths/~1beta~1conversations~1import/post/requestBody","description":"The type of conversation to import"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/import","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.import"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations/import","href":"chatbots/postconversationsimport","openApiOperationId":"postConversationsImport","summary":"Import conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The id of the imported conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/postconversationsimport"}],"panels":[]}]},"httpPath":"/beta/conversations/import"},{"label":"Claim conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclaim","routeSlug":"/openapi/dixa-api/beta/chatbots/putconversationsconversationidclaim","metadata":{"seo":{"title":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidClaim","name":"Claim conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Claim conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paremeter to false"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.claim"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/claim","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.claim"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","409"],"pointer":"/beta/conversations/{conversationId}/claim","href":"chatbots/putconversationsconversationidclaim","openApiOperationId":"putConversationsConversationidClaim","summary":"Claim conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully claimed"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"]},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/putconversationsconversationidclaim"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/claim"},{"label":"Get queue availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getqueuesqueueidavailability","routeSlug":"/openapi/dixa-api/beta/chatbots/getqueuesqueueidavailability","metadata":{"seo":{"title":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueuesQueueidAvailability","name":"Get queue availability","isWebhook":false,"pointer":"/paths/~1beta~1queues~1{queueId}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get queue availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1queues~1{queueId}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues/{queueId}/availability","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"queueId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","409","500"],"pointer":"/beta/queues/{queueId}/availability","href":"chatbots/getqueuesqueueidavailability","openApiOperationId":"getQueuesQueueidAvailability","summary":"Get queue availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The availability of supported channels for a given queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter queueId, Invalid value extracted from request context ,queue does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"]},{"code":"409","description":"The request could not be completed due to no supported channels configured for this organization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1{queueId}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/getqueuesqueueidavailability"}],"panels":[]}]},"httpPath":"/beta/queues/{queueId}/availability"},{"label":"Get the position of the conversation in its current queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/chatbots/getqueuesconversation-positioncsid","routeSlug":"/openapi/dixa-api/beta/chatbots/getqueuesconversation-positioncsid","metadata":{"seo":{"title":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueuesConversation-positionCsid","name":"Get the position of the conversation in its current queue","isWebhook":false,"pointer":"/paths/~1beta~1queues~1conversation-position~1{csid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the position of the conversation in its current queue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the approximate position of a given conversation in its current queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"csid","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1queues~1conversation-position~1{csid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues/conversation-position/{csid}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"csid","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/queues/conversation-position/{csid}","href":"chatbots/getqueuesconversation-positioncsid","openApiOperationId":"getQueuesConversation-positionCsid","summary":"Get the position of the conversation in its current queue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The position of the conversation in the queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter csid, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1conversation-position~1{csid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chatbots/getqueuesconversation-positioncsid"}],"panels":[]}]},"httpPath":"/beta/queues/conversation-position/{csid}"}],"content":{"contentType":"group","meta":{"name":"Chatbots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chatbots","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/endusers","summary":"Create end user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chatbots/postendusers","deprecated":false},{"title":"/beta/endusers/{userId}","summary":"Get end user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chatbots/getendusersuserid","deprecated":false},{"title":"/beta/endusers/{userId}/conversations","summary":"List end user conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chatbots/getendusersuseridconversations","deprecated":false},{"title":"/beta/conversations/{conversationId}/close","summary":"Close conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chatbots/putconversationsconversationidclose","deprecated":false},{"title":"/beta/conversations/{conversationId}/followup","summary":"Followup conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chatbots/putconversationsconversationidfollowup","deprecated":false},{"title":"/beta/conversations/{conversationId}/transfer/queue","summary":"Transfer conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chatbots/putconversationsconversationidtransferqueue","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","summary":"Create conversation rating result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chatbots/postconversationsconversationidratingsratingidsubmit","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings/offer","summary":"Create conversation rating offer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chatbots/postconversationsconversationidratingsoffer","deprecated":false},{"title":"/beta/conversations","summary":"Create conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chatbots/postconversations","deprecated":false},{"title":"/beta/conversations/import","summary":"Import conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chatbots/postconversationsimport","deprecated":false},{"title":"/beta/conversations/{conversationId}/claim","summary":"Claim conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chatbots/putconversationsconversationidclaim","deprecated":false},{"title":"/beta/queues/{queueId}/availability","summary":"Get queue availability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chatbots/getqueuesqueueidavailability","deprecated":false},{"title":"/beta/queues/conversation-position/{csid}","summary":"Get the position of the conversation in its current queue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chatbots/getqueuesconversation-positioncsid","deprecated":false}]}]}]}]}},{"type":"group","label":"Anonymization","link":"/openapi/dixa-api/beta/anonymization","routeSlug":"/openapi/dixa-api/beta/anonymization","items":[{"label":"Anonymize end user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/patchendusersuseridanonymize","routeSlug":"/openapi/dixa-api/beta/anonymization/patchendusersuseridanonymize","metadata":{"seo":{"title":"Anonymize end user","description":"Request the anonymization of an end user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEndusersUseridAnonymize","name":"Anonymize end user","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize end user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of an end user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","description":"The id of the end user to anonymize","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_80","description":"Whether to force close all the conversations initiated by the end user, if any are found in a non closed state."}],"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/endusers/{userId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"force","in":"query","required":false,"schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/endusers/{userId}/anonymize","href":"anonymization/patchendusersuseridanonymize","openApiOperationId":"patchEndusersUseridAnonymize","summary":"Anonymize end user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The end user's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest"}},"schemaId":"components/schemas/BadRequest"},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest"}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/anonymization/patchendusersuseridanonymize"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}/anonymize"},{"label":"Anonymize conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidanonymize","routeSlug":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidanonymize","metadata":{"seo":{"title":"Anonymize conversation","description":"Request the anonymization of a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidAnonymize","name":"Anonymize conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","description":"the id of the conversation to anonymize","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_80","description":"Whether to force close the conversation if it is found in a non closed state."}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[{"name":"force","in":"query","required":false,"schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/conversations/{conversationId}/anonymize","href":"anonymization/patchconversationsconversationidanonymize","openApiOperationId":"patchConversationsConversationidAnonymize","summary":"Anonymize conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The conversation's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: query parameter force","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/anonymization/patchconversationsconversationidanonymize"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/anonymize"},{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/beta/anonymization/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidMessagesMessageidAnonymize","name":"Anonymize message","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of a single message in a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","description":"the id of the conversation in which the message belongs","required":true},{"name":"messageId","in":"path","schemaId":"schema_79","description":"the id of the message to anonymize","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","href":"anonymization/patchconversationsconversationidmessagesmessageidanonymize","openApiOperationId":"patchConversationsConversationidMessagesMessageidAnonymize","summary":"Anonymize message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The message's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter messageId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/anonymization/patchconversationsconversationidmessagesmessageidanonymize"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize"},{"label":"Get anonymization status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/getanonymizationrequestrequestid","routeSlug":"/openapi/dixa-api/beta/anonymization/getanonymizationrequestrequestid","metadata":{"seo":{"title":"Get anonymization status","description":"Retrieve an anonymization request submitted earlier (user or conversation)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAnonymizationRequestRequestid","name":"Get anonymization status","isWebhook":false,"pointer":"/paths/~1beta~1anonymization~1request~1{requestId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get anonymization status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve an anonymization request submitted earlier (user or conversation)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"requestId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1anonymization~1request~1{requestId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/anonymization/request/{requestId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"requestId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/beta/anonymization/request/{requestId}","href":"anonymization/getanonymizationrequestrequestid","openApiOperationId":"getAnonymizationRequestRequestid","summary":"Get anonymization status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The anonymization request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter requestId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/401/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1anonymization~1request~1{requestId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization~1request~1{requestId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/anonymization/getanonymizationrequestrequestid"}],"panels":[]}]},"httpPath":"/beta/anonymization/request/{requestId}"},{"label":"Anonymize entity","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/anonymization/postanonymization","routeSlug":"/openapi/dixa-api/beta/anonymization/postanonymization","metadata":{"seo":{"title":"Anonymize entity","description":"Anonymize the requested entity (user or conversation). For a conversation to be successfully anonymized, it should be in the status closed. Otherwise, it requires forceAnonymization parameter set to true in the input body. NOTE: This endpoint is deprecated. Prefer using the anonymization endpoints of specific resources instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postAnonymization","name":"Anonymize entity","deprecated":true,"isWebhook":false,"pointer":"/paths/~1beta~1anonymization/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize entity","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Anonymize the requested entity (user or conversation). For a conversation to be successfully anonymized, it should be in the status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, it requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forceAnonymization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the input body. NOTE: This endpoint is deprecated. Prefer using the anonymization endpoints of specific resources instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityInput","exampleIds":["paths/~1beta~1anonymization/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityInput","exampleIds":["paths/~1beta~1anonymization/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1anonymization/post/requestBody","description":"A request to anonymize an entity in the system (user or conversation)."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/anonymization","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityInput","exampleIds":["paths/~1beta~1anonymization/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/anonymization","href":"anonymization/postanonymization","openApiOperationId":"postAnonymization","summary":"Anonymize entity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/AnonymizeEntityInput","exampleIds":["paths/~1beta~1anonymization/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityInput","exampleIds":["paths/~1beta~1anonymization/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization/post/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1anonymization/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1anonymization/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1anonymization/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1anonymization/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/anonymization/postanonymization"}],"panels":[]}]},"httpPath":"/beta/anonymization"}],"content":{"contentType":"group","meta":{"name":"Anonymization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymization","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/endusers/{userId}/anonymize","summary":"Anonymize end user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/anonymization/patchendusersuseridanonymize","deprecated":false},{"title":"/beta/conversations/{conversationId}/anonymize","summary":"Anonymize conversation","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/anonymization/patchconversationsconversationidanonymize","deprecated":false},{"title":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","summary":"Anonymize message","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/anonymization/patchconversationsconversationidmessagesmessageidanonymize","deprecated":false},{"title":"/beta/anonymization/request/{requestId}","summary":"Get anonymization status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/anonymization/getanonymizationrequestrequestid","deprecated":false},{"title":"/beta/anonymization","summary":"Anonymize entity","prefix":{"name":"post","color":"http-deprecated"},"badges":[],"link":"/anonymization/postanonymization","deprecated":true}]}]}]}]}},{"type":"group","label":"Custom Attributes","link":"/openapi/dixa-api/beta/custom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes","items":[{"label":"Patch end user custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/patchendusersuseridcustom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes/patchendusersuseridcustom-attributes","metadata":{"seo":{"title":"Patch end user custom attributes","description":"Patch custom attributes of an end user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchEndusersUseridCustom-attributes","name":"Patch end user custom attributes","isWebhook":false,"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch end user custom attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch custom attributes of an end user"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["contact.custom_attribute"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/endusers/{userId}/custom-attributes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["contact.custom_attribute"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/beta/endusers/{userId}/custom-attributes","href":"custom-attributes/patchendusersuseridcustom-attributes","openApiOperationId":"patchEndusersUseridCustom-attributes","summary":"Patch end user custom attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched end user attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter userId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchEndUserCustomAttributesOutput","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-attributes/patchendusersuseridcustom-attributes"}],"panels":[]}]},"httpPath":"/beta/endusers/{userId}/custom-attributes"},{"label":"Patch conversation custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/patchconversationsconversationidcustom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes/patchconversationsconversationidcustom-attributes","metadata":{"seo":{"title":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidCustom-attributes","name":"Patch conversation custom attributes","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch conversation custom attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch custom attributes of a conversation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.custom_attribute"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/custom-attributes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.custom_attribute"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/beta/conversations/{conversationId}/custom-attributes","href":"custom-attributes/patchconversationsconversationidcustom-attributes","openApiOperationId":"patchConversationsConversationidCustom-attributes","summary":"Patch conversation custom attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched conversation attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-attributes/patchconversationsconversationidcustom-attributes"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/custom-attributes"},{"label":"Get custom attribute definition by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributescustomattributeid","routeSlug":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributescustomattributeid","metadata":{"seo":{"title":"Get custom attribute definition by id","description":"Get custom attribute in an organization by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustom-attributesCustomattributeid","name":"Get custom attribute definition by id","isWebhook":false,"pointer":"/paths/~1beta~1custom-attributes~1{customAttributeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get custom attribute definition by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get custom attribute in an organization by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"customAttributeId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1custom-attributes~1{customAttributeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/custom-attributes/{customAttributeId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"customAttributeId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/custom-attributes/{customAttributeId}","href":"custom-attributes/getcustom-attributescustomattributeid","openApiOperationId":"getCustom-attributesCustomattributeid","summary":"Get custom attribute definition by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The configured custom attribute","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-attributes/getcustom-attributescustomattributeid"}],"panels":[]}]},"httpPath":"/beta/custom-attributes/{customAttributeId}"},{"label":"List custom attributes definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributes","routeSlug":"/openapi/dixa-api/beta/custom-attributes/getcustom-attributes","metadata":{"seo":{"title":"List custom attributes definitions","description":"List all custom attributes in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustom-attributes","name":"List custom attributes definitions","isWebhook":false,"pointer":"/paths/~1beta~1custom-attributes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom attributes definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all custom attributes in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/custom-attributes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/custom-attributes","href":"custom-attributes/getcustom-attributes","openApiOperationId":"getCustom-attributes","summary":"List custom attributes definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of configured custom attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1custom-attributes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCustomAttributesDefinitionsOutput","exampleIds":["paths/~1beta~1custom-attributes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1custom-attributes/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1custom-attributes/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-attributes/getcustom-attributes"}],"panels":[]}]},"httpPath":"/beta/custom-attributes"}],"content":{"contentType":"group","meta":{"name":"Custom Attributes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Attributes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/endusers/{userId}/custom-attributes","summary":"Patch end user custom attributes","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-attributes/patchendusersuseridcustom-attributes","deprecated":false},{"title":"/beta/conversations/{conversationId}/custom-attributes","summary":"Patch conversation custom attributes","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-attributes/patchconversationsconversationidcustom-attributes","deprecated":false},{"title":"/beta/custom-attributes/{customAttributeId}","summary":"Get custom attribute definition by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-attributes/getcustom-attributescustomattributeid","deprecated":false},{"title":"/beta/custom-attributes","summary":"List custom attributes definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-attributes/getcustom-attributes","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams","link":"/openapi/dixa-api/beta/teams","routeSlug":"/openapi/dixa-api/beta/teams","items":[{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteams","routeSlug":"/openapi/dixa-api/beta/teams/getteams","metadata":{"seo":{"title":"List teams","description":"Lists all teams in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTeams","name":"List teams","isWebhook":false,"pointer":"/paths/~1beta~1teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List teams","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all teams in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/teams","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/teams","href":"teams/getteams","openApiOperationId":"getTeams","summary":"List teams"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of teams in an organization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTeamsOutput","exampleIds":["paths/~1beta~1teams/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListTeamsOutput","exampleIds":["paths/~1beta~1teams/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTeamsOutput","exampleIds":["paths/~1beta~1teams/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTeamsOutput","exampleIds":["paths/~1beta~1teams/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/getteams"}],"panels":[]}]},"httpPath":"/beta/teams"},{"label":"Create team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/postteams","routeSlug":"/openapi/dixa-api/beta/teams/postteams","metadata":{"seo":{"title":"Create team","description":"Create a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postTeams","name":"Create team","isWebhook":false,"pointer":"/paths/~1beta~1teams/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.team"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTeamInput","exampleIds":["paths/~1beta~1teams/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTeamInput","exampleIds":["paths/~1beta~1teams/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1teams/post/requestBody","description":"The team name"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/teams","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.team"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTeamInput","exampleIds":["paths/~1beta~1teams/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/teams","href":"teams/postteams","openApiOperationId":"postTeams","summary":"Create team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateTeamInput","exampleIds":["paths/~1beta~1teams/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTeamInput","exampleIds":["paths/~1beta~1teams/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created team","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/postteams"}],"panels":[]}]},"httpPath":"/beta/teams"},{"label":"List members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteamsteamidagents","routeSlug":"/openapi/dixa-api/beta/teams/getteamsteamidagents","metadata":{"seo":{"title":"List members","description":"Lists all agents/admins in a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTeamsTeamidAgents","name":"List members","isWebhook":false,"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all agents/admins in a team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_79","description":"The team id","required":true}],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/teams/{teamId}/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/teams/{teamId}/agents","href":"teams/getteamsteamidagents","openApiOperationId":"getTeamsTeamidAgents","summary":"List members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of agents/admins in the specified team","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTeamMembersOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListTeamMembersOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter teamId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTeamMembersOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTeamMembersOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/getteamsteamidagents"}],"panels":[]}]},"httpPath":"/beta/teams/{teamId}/agents"},{"label":"Remove members","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/deleteteamsteamidagents","routeSlug":"/openapi/dixa-api/beta/teams/deleteteamsteamidagents","metadata":{"seo":{"title":"Remove members","description":"Remove agents/admins from a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTeamsTeamidAgents","name":"Remove members","isWebhook":false,"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove agents/admins from a team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.team"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_79","description":"The team id","required":true}],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteAgentsFromTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/DeleteAgentsFromTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody","description":"List of agent/admin ids to remove from the specified team"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/teams/{teamId}/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.team"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeleteAgentsFromTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","500"],"pointer":"/beta/teams/{teamId}/agents","href":"teams/deleteteamsteamidagents","openApiOperationId":"deleteTeamsTeamidAgents","summary":"Remove members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/DeleteAgentsFromTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeleteAgentsFromTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The agents/admins were successfully removed from the team"},{"code":"400","description":"Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/deleteteamsteamidagents"}],"panels":[]}]},"httpPath":"/beta/teams/{teamId}/agents"},{"label":"Add members","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/patchteamsteamidagents","routeSlug":"/openapi/dixa-api/beta/teams/patchteamsteamidagents","metadata":{"seo":{"title":"Add members","description":"Add agents/admins to a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTeamsTeamidAgents","name":"Add members","isWebhook":false,"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add agents/admins to a team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_79","description":"The team id","required":true}],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgentsToTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/AgentsToTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody","description":"List of agent/admin ids to add to the specified team"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/teams/{teamId}/agents","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AgentsToTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/teams/{teamId}/agents","href":"teams/patchteamsteamidagents","openApiOperationId":"patchTeamsTeamidAgents","summary":"Add members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/AgentsToTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgentsToTeamInput","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200"},{"code":"400","description":"Invalid value for: path parameter teamId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams~1{teamId}~1agents/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1agents/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/patchteamsteamidagents"}],"panels":[]}]},"httpPath":"/beta/teams/{teamId}/agents"},{"label":"List presence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteamsteamidpresence","routeSlug":"/openapi/dixa-api/beta/teams/getteamsteamidpresence","metadata":{"seo":{"title":"List presence","description":"List the presence status of all agents/admins in a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTeamsTeamidPresence","name":"List presence","isWebhook":false,"pointer":"/paths/~1beta~1teams~1{teamId}~1presence/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List presence","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the presence status of all agents/admins in a team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_79","description":"The team id","required":true}],"pointer":"/paths/~1beta~1teams~1{teamId}~1presence/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1teams~1{teamId}~1presence/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/teams/{teamId}/presence","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/teams/{teamId}/presence","href":"teams/getteamsteamidpresence","openApiOperationId":"getTeamsTeamidPresence","summary":"List presence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of agents/admins presence status in the specified team","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPresenceOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListPresenceOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams~1{teamId}~1presence/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPresenceOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPresenceOutput","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}~1presence/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/getteamsteamidpresence"}],"panels":[]}]},"httpPath":"/beta/teams/{teamId}/presence"},{"label":"Get team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/getteamsteamid","routeSlug":"/openapi/dixa-api/beta/teams/getteamsteamid","metadata":{"seo":{"title":"Get team","description":"Get a team by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTeamsTeamid","name":"Get team","isWebhook":false,"pointer":"/paths/~1beta~1teams~1{teamId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a team by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_79","description":"The team id","required":true}],"pointer":"/paths/~1beta~1teams~1{teamId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/teams/{teamId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/beta/teams/{teamId}","href":"teams/getteamsteamid","openApiOperationId":"getTeamsTeamid","summary":"Get team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The team","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter teamId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams~1{teamId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTeamOutput","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1teams~1{teamId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/getteamsteamid"}],"panels":[]}]},"httpPath":"/beta/teams/{teamId}"},{"label":"Delete team","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/teams/deleteteamsteamid","routeSlug":"/openapi/dixa-api/beta/teams/deleteteamsteamid","metadata":{"seo":{"title":"Delete team","description":"Delete a team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTeamsTeamid","name":"Delete team","isWebhook":false,"pointer":"/paths/~1beta~1teams~1{teamId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["organization.team"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"teamId","in":"path","schemaId":"schema_79","description":"The team id","required":true}],"pointer":"/paths/~1beta~1teams~1{teamId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/teams/{teamId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"teamId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["organization.team"]}],"responseCodes":["204","400","500"],"pointer":"/beta/teams/{teamId}","href":"teams/deleteteamsteamid","openApiOperationId":"deleteTeamsTeamid","summary":"Delete team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The team was successfully deleted"},{"code":"400","description":"Invalid value for: path parameter teamId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1teams~1{teamId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1teams~1{teamId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/teams/deleteteamsteamid"}],"panels":[]}]},"httpPath":"/beta/teams/{teamId}"}],"content":{"contentType":"group","meta":{"name":"Teams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teams","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/teams","summary":"List teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/getteams","deprecated":false},{"title":"/beta/teams","summary":"Create team","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams/postteams","deprecated":false},{"title":"/beta/teams/{teamId}/agents","summary":"List members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/getteamsteamidagents","deprecated":false},{"title":"/beta/teams/{teamId}/agents","summary":"Remove members","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/teams/deleteteamsteamidagents","deprecated":false},{"title":"/beta/teams/{teamId}/agents","summary":"Add members","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/teams/patchteamsteamidagents","deprecated":false},{"title":"/beta/teams/{teamId}/presence","summary":"List presence","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/getteamsteamidpresence","deprecated":false},{"title":"/beta/teams/{teamId}","summary":"Get team","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/getteamsteamid","deprecated":false},{"title":"/beta/teams/{teamId}","summary":"Delete team","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/teams/deleteteamsteamid","deprecated":false}]}]}]}]}},{"type":"group","label":"Conversations","link":"/openapi/dixa-api/beta/conversations","routeSlug":"/openapi/dixa-api/beta/conversations","items":[{"label":"Anonymize conversation","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidanonymize","routeSlug":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidanonymize","metadata":{"seo":{"title":"Anonymize conversation","description":"Request the anonymization of a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidAnonymize","name":"Anonymize conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","description":"the id of the conversation to anonymize","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"force","in":"query","schemaId":"schema_80","description":"Whether to force close the conversation if it is found in a non closed state."}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[{"name":"force","in":"query","required":false,"schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/conversations/{conversationId}/anonymize","href":"conversations/patchconversationsconversationidanonymize","openApiOperationId":"patchConversationsConversationidAnonymize","summary":"Anonymize conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The conversation's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: query parameter force","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/patchconversationsconversationidanonymize"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/anonymize"},{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidMessagesMessageidAnonymize","name":"Anonymize message","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of a single message in a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","description":"the id of the conversation in which the message belongs","required":true},{"name":"messageId","in":"path","schemaId":"schema_79","description":"the id of the message to anonymize","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","href":"conversations/patchconversationsconversationidmessagesmessageidanonymize","openApiOperationId":"patchConversationsConversationidMessagesMessageidAnonymize","summary":"Anonymize message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The message's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter messageId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/patchconversationsconversationidmessagesmessageidanonymize"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize"},{"label":"Close conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclose","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclose","metadata":{"seo":{"title":"Close conversation","description":"Mark a conversation as closed by providing its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidClose","name":"Close conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a conversation as closed by providing its id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody","description":"An optional agent/admin to close the conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/close","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404"],"pointer":"/beta/conversations/{conversationId}/close","href":"conversations/putconversationsconversationidclose","openApiOperationId":"putConversationsConversationidClose","summary":"Close conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloseConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully closed"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1close/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidclose"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/close"},{"label":"Followup conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidfollowup","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidfollowup","metadata":{"seo":{"title":"Followup conversation","description":"Follow up a conversation by providing its id and expiration timestamp."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidFollowup","name":"Followup conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Followup conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Follow up a conversation by providing its id and expiration timestamp."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody","description":"A request to followup the conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/followup","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404"],"pointer":"/beta/conversations/{conversationId}/followup","href":"conversations/putconversationsconversationidfollowup","openApiOperationId":"putConversationsConversationidFollowup","summary":"Followup conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FollowupConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully followed up"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1followup/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidfollowup"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/followup"},{"label":"Reopen conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidreopen","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidreopen","metadata":{"seo":{"title":"Reopen conversation","description":"Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidReopen","name":"Reopen conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1reopen/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reopen conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1reopen/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReopenConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ReopenConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody","description":"An optional agent/admin to reopen the conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/reopen","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReopenConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/reopen","href":"conversations/putconversationsconversationidreopen","openApiOperationId":"putConversationsConversationidReopen","summary":"Reopen conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/ReopenConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReopenConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully reopened and offered in the same queue"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidreopen"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/reopen"},{"label":"Transfer conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtransferqueue","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtransferqueue","metadata":{"seo":{"title":"Transfer conversation","description":"Transfer a conversation to a target queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidTransferQueue","name":"Transfer conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Transfer a conversation to a target queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody","description":"Transfer conversation request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/transfer/queue","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/transfer/queue","href":"conversations/putconversationsconversationidtransferqueue","openApiOperationId":"putConversationsConversationidTransferQueue","summary":"Transfer conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully transferred to the target queue"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin, Queue does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidtransferqueue"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/transfer/queue"},{"label":"Add internal notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotesbulk","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotesbulk","metadata":{"seo":{"title":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidNotesBulk","name":"Add internal notes","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add internal notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create internal notes in a conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"]}},"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody","description":"The list of internal notes to create for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/notes/bulk","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/notes/bulk","href":"conversations/postconversationsconversationidnotesbulk","openApiOperationId":"postConversationsConversationidNotesBulk","summary":"Add internal notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The created internal notes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"]}},"schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsconversationidnotesbulk"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/notes/bulk"},{"label":"List internal notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidnotes","metadata":{"seo":{"title":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidNotes","name":"List internal notes","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List internal notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all internal notes for a particular conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/notes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/notes","href":"conversations/getconversationsconversationidnotes","openApiOperationId":"getConversationsConversationidNotes","summary":"List internal notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of internal notes for a conversation sorted from oldest to newest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidnotes"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/notes"},{"label":"Add internal note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidnotes","metadata":{"seo":{"title":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidNotes","name":"Add internal note","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add internal note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an internal note in a conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"]}},"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody","description":"The internal note to create for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/notes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/notes","href":"conversations/postconversationsconversationidnotes","openApiOperationId":"postConversationsConversationidNotes","summary":"Add internal note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The created internal note","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"]}},"schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsconversationidnotes"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/notes"},{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidRatingsRatingidSubmit","name":"Create conversation rating result","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation rating result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rating result for a specific conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.satisfaction"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"ratingId","in":"path","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ratingId parameter has to be the ID of the offer created via invoking the /conversations/{conversationId}/ratings/offer endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody","description":"The rating result to be created for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"ratingId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.satisfaction"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","href":"conversations/postconversationsconversationidratingsratingidsubmit","openApiOperationId":"postConversationsConversationidRatingsRatingidSubmit","summary":"Create conversation rating result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created conversation rating result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsconversationidratingsratingidsubmit"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidRatingsOffer","name":"Create conversation rating offer","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation rating offer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rating offer for a specific conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.satisfaction"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody","description":"The rating offer to be created for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/ratings/offer","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.satisfaction"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations/{conversationId}/ratings/offer","href":"conversations/postconversationsconversationidratingsoffer","openApiOperationId":"postConversationsConversationidRatingsOffer","summary":"Create conversation rating offer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created conversation rating offer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsconversationidratingsoffer"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings/offer"},{"label":"List ratings for a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidratings","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidratings","metadata":{"seo":{"title":"List ratings for a conversation","description":"Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status \"Rated\". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of \"Offered\" and \"Rated\" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidRatings","name":"List ratings for a conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ratings for a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/ratings","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/ratings","href":"conversations/getconversationsconversationidratings","openApiOperationId":"getConversationsConversationidRatings","summary":"List ratings for a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ratings for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"]}},"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidratings"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings"},{"label":"List organization activity log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsactivitylog","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsactivitylog","metadata":{"seo":{"title":"List organization activity log","description":"List all activity logs for an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsActivitylog","name":"List organization activity log","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1activitylog/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List organization activity log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all activity logs for an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.log"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."},{"name":"fromDatetime","in":"query","schemaId":"schema_82","description":"Starting date-time filter with ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"},{"name":"toDatetime","in":"query","schemaId":"schema_82","description":"Ending date-time filter with ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"}],"pointer":"/paths/~1beta~1conversations~1activitylog/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/activitylog","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"},{"name":"fromDatetime","in":"query","required":false,"schemaId":"schema_82"},{"name":"toDatetime","in":"query","required":false,"schemaId":"schema_82"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.log"]}],"responseCodes":["200","400","500"],"pointer":"/beta/conversations/activitylog","href":"conversations/getconversationsactivitylog","openApiOperationId":"getConversationsActivitylog","summary":"List organization activity log"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The full list of activity logs for an organization with pagination","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1activitylog/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1activitylog/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsactivitylog"}],"panels":[]}]},"httpPath":"/beta/conversations/activitylog"},{"label":"List flows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsflows","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsflows","metadata":{"seo":{"title":"List flows","description":"List all conversations flows in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsFlows","name":"List flows","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1flows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List flows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all conversations flows in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.flow:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"channel","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}]}],"pointer":"/paths/~1beta~1conversations~1flows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/flows","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"channel","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.flow:r"]}],"responseCodes":["200","400","500"],"pointer":"/beta/conversations/flows","href":"conversations/getconversationsflows","openApiOperationId":"getConversationsFlows","summary":"List flows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of conversation flows","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListFlowsOutput","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListFlowsOutput","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter channel","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1flows/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListFlowsOutput","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListFlowsOutput","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1flows/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsflows"}],"panels":[]}]},"httpPath":"/beta/conversations/flows"},{"label":"Tag conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidtagstagid","metadata":{"seo":{"title":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidTagsTagid","name":"Tag conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tag a conversation. You may only use active tags to tag conversations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"tagId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/tags/{tagId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags/{tagId}","href":"conversations/putconversationsconversationidtagstagid","openApiOperationId":"putConversationsConversationidTagsTagid","summary":"Tag conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully tagged"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidtagstagid"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}"},{"label":"Untag conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/deleteconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/conversations/deleteconversationsconversationidtagstagid","metadata":{"seo":{"title":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConversationsConversationidTagsTagid","name":"Untag conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untag a conversation. You may remove active or inactive tags from a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"tagId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/conversations/{conversationId}/tags/{tagId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags/{tagId}","href":"conversations/deleteconversationsconversationidtagstagid","openApiOperationId":"deleteConversationsConversationidTagsTagid","summary":"Untag conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully untagged"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/deleteconversationsconversationidtagstagid"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}"},{"label":"Bulk tag conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidtagsbulk","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidtagsbulk","metadata":{"seo":{"title":"Bulk tag conversation","description":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidTagsBulk","name":"Bulk tag conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk tag conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody","description":"The list of tags to add to a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/tags/bulk","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.tag"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags/bulk","href":"conversations/postconversationsconversationidtagsbulk","openApiOperationId":"postConversationsConversationidTagsBulk","summary":"Bulk tag conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The conversation bulk tag was initiated"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsconversationidtagsbulk"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags/bulk"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidtags","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidtags","metadata":{"seo":{"title":"List tags","description":"Get the tags for a particular conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidTags","name":"List tags","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the tags for a particular conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/tags","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags","href":"conversations/getconversationsconversationidtags","openApiOperationId":"getConversationsConversationidTags","summary":"List tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of tags for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidtags"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags"},{"label":"List messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidmessages","metadata":{"seo":{"title":"List messages","description":"Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of \"_type\": \"EmailAttributes\" if they are created through a webform, or \"_type\": \"ContactFormAttributes\" when created through a chat widget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidMessages","name":"List messages","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all messages for a particular conversation by providing the conversation id. Note that messages in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactForm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" conversations can have attributes of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"_type\": \"EmailAttributes\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if they are created through a webform, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"_type\": \"ContactFormAttributes\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when created through a chat widget."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/messages","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/beta/conversations/{conversationId}/messages","href":"conversations/getconversationsconversationidmessages","openApiOperationId":"getConversationsConversationidMessages","summary":"List messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of messages for a conversation sorted from oldest to newest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"]}},"schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidmessages"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages"},{"label":"Add message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsconversationidmessages","metadata":{"seo":{"title":"Add message","description":"Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. If attachments are added to the message, they will be copied and stored in Dixa.  Content in outbound message is required except for Whatsapp messages.  Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only).  Supported Markdown syntax for Markdown content: bold **text**, italic *text*, bold & italic ***text***, strikethrough ~text~, blockquote  > Quoted text. \\n Message about quoted text, ordered list List:\\n1. Item\\n2. Item\\n3. Item, unordered list List:\\n* Item\\n* Item\\n* Item, inline code This is `code`.  Whatsapp channel:  Only one attachment is allowed per WhatsApp message.  Supports adding a message with attachment only (no content).  Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidMessages","name":"Add message","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If attachments are added to the message, they will be copied and stored in Dixa. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Content in outbound message is required except for Whatsapp messages. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported Markdown syntax for Markdown content: bold "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"**text**"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", italic "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*text*"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", bold & italic "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"***text***"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", strikethrough "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"~text~"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", blockquote "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > Quoted text. \\n Message about quoted text"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ordered list "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List:\\n1. Item\\n2. Item\\n3. Item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unordered list "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List:\\n* Item\\n* Item\\n* Item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", inline code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is `code`"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Whatsapp channel: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only one attachment is allowed per WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supports adding a message with attachment only (no content). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"]}},"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody","description":"The message to be added to a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/messages","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/messages","href":"conversations/postconversationsconversationidmessages","openApiOperationId":"postConversationsConversationidMessages","summary":"Add message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The added message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsconversationidmessages"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages"},{"label":"Create conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversations","routeSlug":"/openapi/dixa-api/beta/conversations/postconversations","metadata":{"seo":{"title":"Create conversation","description":"Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversations","name":"Create conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"]}},"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"],"pointer":"/paths/~1beta~1conversations/post/requestBody","description":"The conversation to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations","href":"conversations/postconversations","openApiOperationId":"postConversations","summary":"Create conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateConversationInput","exampleIds":["paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email","paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The id of the created conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Duplicate externalId, Unsupported ConversationChannel","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateConversationOutput","exampleIds":["paths/~1beta~1conversations/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversations"}],"panels":[]}]},"httpPath":"/beta/conversations"},{"label":"Import conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postconversationsimport","routeSlug":"/openapi/dixa-api/beta/conversations/postconversationsimport","metadata":{"seo":{"title":"Import conversation","description":"Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user), unless the specific channel supports overriding the message author through its attributes. For outbound messages the author is specified using the agentId field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsImport","name":"Import conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1import/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.import"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"]}},"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"],"pointer":"/paths/~1beta~1conversations~1import/post/requestBody","description":"The type of conversation to import"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/import","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.import"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations/import","href":"conversations/postconversationsimport","openApiOperationId":"postConversationsImport","summary":"Import conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GenericConversationImport","exampleIds":["paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example","paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The id of the imported conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportConversationOutput","exampleIds":["paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postconversationsimport"}],"panels":[]}]},"httpPath":"/beta/conversations/import"},{"label":"Patch conversation custom attributes","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidcustom-attributes","routeSlug":"/openapi/dixa-api/beta/conversations/patchconversationsconversationidcustom-attributes","metadata":{"seo":{"title":"Patch conversation custom attributes","description":"Patch custom attributes of a conversation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidCustom-attributes","name":"Patch conversation custom attributes","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch conversation custom attributes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch custom attributes of a conversation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.custom_attribute"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/custom-attributes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.custom_attribute"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/beta/conversations/{conversationId}/custom-attributes","href":"conversations/patchconversationsconversationidcustom-attributes","openApiOperationId":"patchConversationsConversationidCustom-attributes","summary":"Patch conversation custom attributes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Map_UUID_Option_AttributeValue","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched conversation attributes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchConversationCustomAttributesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/patchconversationsconversationidcustom-attributes"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/custom-attributes"},{"label":"Claim conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclaim","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidclaim","metadata":{"seo":{"title":"Claim conversation","description":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force paremeter to false"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidClaim","name":"Claim conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Claim conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Claim a conversation for a given agent. To avoid taking over assigned conversations, set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"force"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" paremeter to false"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.claim"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/claim","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.claim"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","409"],"pointer":"/beta/conversations/{conversationId}/claim","href":"conversations/putconversationsconversationidclaim","openApiOperationId":"putConversationsConversationidClaim","summary":"Claim conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClaimConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully claimed"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"]},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1claim/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidclaim"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/claim"},{"label":"List activity log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidactivitylog","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidactivitylog","metadata":{"seo":{"title":"List activity log","description":"Get the activity log for a conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidActivitylog","name":"List activity log","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1activitylog/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List activity log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the activity log for a conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.log"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1activitylog/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/activitylog","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.log"]}],"responseCodes":["200","400","500"],"pointer":"/beta/conversations/{conversationId}/activitylog","href":"conversations/getconversationsconversationidactivitylog","openApiOperationId":"getConversationsConversationidActivitylog","summary":"List activity log"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Activity log entries for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetActivityLogOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidactivitylog"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/activitylog"},{"label":"Get conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationid","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationid","metadata":{"seo":{"title":"Get conversation","description":"Get a conversation by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationid","name":"Get conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a conversation by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}","href":"conversations/getconversationsconversationid","openApiOperationId":"getConversationsConversationid","summary":"Get conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetConversationOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetConversationOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetConversationOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetConversationOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationid"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}"},{"label":"Link a conversation to a parent conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/putconversationsconversationidlink","routeSlug":"/openapi/dixa-api/beta/conversations/putconversationsconversationidlink","metadata":{"seo":{"title":"Link a conversation to a parent conversation","description":"Links the specified conversation to a parent conversation with the specified link type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidLink","name":"Link a conversation to a parent conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1link/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link a conversation to a parent conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links the specified conversation to a parent conversation with the specified link type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limitations:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum of 100 child conversations per parent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only 1 parent per child conversation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A child conversation cannot have its own child conversations"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1link/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/LinkConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody","description":"The parent conversation ID and link type"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/link","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/link","href":"conversations/putconversationsconversationidlink","openApiOperationId":"putConversationsConversationidLink","summary":"Link a conversation to a parent conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/LinkConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1link/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1link/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/putconversationsconversationidlink"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/link"},{"label":"List linked conversations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidlinked","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidlinked","metadata":{"seo":{"title":"List linked conversations","description":"Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidLinked","name":"List linked conversations","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1linked/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List linked conversations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1linked/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/linked","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/linked","href":"conversations/getconversationsconversationidlinked","openApiOperationId":"getConversationsConversationidLinked","summary":"List linked conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of conversations requested by an EndUser","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLinkedConversationsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListLinkedConversationsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1linked/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListLinkedConversationsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListLinkedConversationsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidlinked"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/linked"},{"label":"Search conversations with filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/postsearchconversations","routeSlug":"/openapi/dixa-api/beta/conversations/postsearchconversations","metadata":{"seo":{"title":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSearchConversations","name":"Search conversations with filters","isWebhook":false,"pointer":"/paths/~1beta~1search~1conversations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search conversations with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for conversations containing a particular text or by filter or combine them both"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1search~1conversations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"]}},"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"],"pointer":"/paths/~1beta~1search~1conversations/post/requestBody","description":"The filters to apply to the search"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/search/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"]}},"responseCodes":["200","400","401","500"],"pointer":"/beta/search/conversations","href":"conversations/postsearchconversations","openApiOperationId":"postSearchConversations","summary":"Search conversations with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The search results for the searched parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"]}},"schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1search~1conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/postsearchconversations"}],"panels":[]}]},"httpPath":"/beta/search/conversations"},{"label":"List rating","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getconversationsconversationidrating","routeSlug":"/openapi/dixa-api/beta/conversations/getconversationsconversationidrating","metadata":{"seo":{"title":"List rating","description":"Deprecated rating endpoint. Use '/ratings'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidRating","name":"List rating","deprecated":true,"isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1rating/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rating","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated rating endpoint. Use '/ratings'."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1rating/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/rating","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/rating","href":"conversations/getconversationsconversationidrating","openApiOperationId":"getConversationsConversationidRating","summary":"List rating"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ratings for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1rating/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getconversationsconversationidrating"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/rating"},{"label":"Search conversations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/conversations/getsearchconversations","routeSlug":"/openapi/dixa-api/beta/conversations/getsearchconversations","metadata":{"seo":{"title":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSearchConversations","name":"Search conversations","deprecated":true,"isWebhook":false,"pointer":"/paths/~1beta~1search~1conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search conversations","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."},{"name":"query","in":"query","schemaId":"schema_83","description":"The text by which to search conversations","required":true,"example":"cancel my order"},{"name":"exactMatch","in":"query","schemaId":"schema_84","description":"Return only exact matches. This value is false by default."}],"pointer":"/paths/~1beta~1search~1conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/search/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"},{"name":"query","in":"query","required":true,"example":"cancel my order","schemaId":"schema_83"},{"name":"exactMatch","in":"query","required":false,"schemaId":"schema_84"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/beta/search/conversations","href":"conversations/getsearchconversations","openApiOperationId":"getSearchConversations","summary":"Search conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The search results for the searched parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1search~1conversations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conversations/getsearchconversations"}],"panels":[]}]},"httpPath":"/beta/search/conversations"}],"content":{"contentType":"group","meta":{"name":"Conversations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conversations","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/conversations/{conversationId}/anonymize","summary":"Anonymize conversation","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/conversations/patchconversationsconversationidanonymize","deprecated":false},{"title":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","summary":"Anonymize message","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/conversations/patchconversationsconversationidmessagesmessageidanonymize","deprecated":false},{"title":"/beta/conversations/{conversationId}/close","summary":"Close conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidclose","deprecated":false},{"title":"/beta/conversations/{conversationId}/followup","summary":"Followup conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidfollowup","deprecated":false},{"title":"/beta/conversations/{conversationId}/reopen","summary":"Reopen conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidreopen","deprecated":false},{"title":"/beta/conversations/{conversationId}/transfer/queue","summary":"Transfer conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidtransferqueue","deprecated":false},{"title":"/beta/conversations/{conversationId}/notes/bulk","summary":"Add internal notes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsconversationidnotesbulk","deprecated":false},{"title":"/beta/conversations/{conversationId}/notes","summary":"List internal notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationidnotes","deprecated":false},{"title":"/beta/conversations/{conversationId}/notes","summary":"Add internal note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsconversationidnotes","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","summary":"Create conversation rating result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsconversationidratingsratingidsubmit","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings/offer","summary":"Create conversation rating offer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsconversationidratingsoffer","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings","summary":"List ratings for a conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationidratings","deprecated":false},{"title":"/beta/conversations/activitylog","summary":"List organization activity log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsactivitylog","deprecated":false},{"title":"/beta/conversations/flows","summary":"List flows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsflows","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags/{tagId}","summary":"Tag conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidtagstagid","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags/{tagId}","summary":"Untag conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/conversations/deleteconversationsconversationidtagstagid","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags/bulk","summary":"Bulk tag conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsconversationidtagsbulk","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags","summary":"List tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationidtags","deprecated":false},{"title":"/beta/conversations/{conversationId}/messages","summary":"List messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationidmessages","deprecated":false},{"title":"/beta/conversations/{conversationId}/messages","summary":"Add message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsconversationidmessages","deprecated":false},{"title":"/beta/conversations","summary":"Create conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversations","deprecated":false},{"title":"/beta/conversations/import","summary":"Import conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postconversationsimport","deprecated":false},{"title":"/beta/conversations/{conversationId}/custom-attributes","summary":"Patch conversation custom attributes","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/conversations/patchconversationsconversationidcustom-attributes","deprecated":false},{"title":"/beta/conversations/{conversationId}/claim","summary":"Claim conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidclaim","deprecated":false},{"title":"/beta/conversations/{conversationId}/activitylog","summary":"List activity log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationidactivitylog","deprecated":false},{"title":"/beta/conversations/{conversationId}","summary":"Get conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationid","deprecated":false},{"title":"/beta/conversations/{conversationId}/link","summary":"Link a conversation to a parent conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/conversations/putconversationsconversationidlink","deprecated":false},{"title":"/beta/conversations/{conversationId}/linked","summary":"List linked conversations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conversations/getconversationsconversationidlinked","deprecated":false},{"title":"/beta/search/conversations","summary":"Search conversations with filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/conversations/postsearchconversations","deprecated":false},{"title":"/beta/conversations/{conversationId}/rating","summary":"List rating","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/conversations/getconversationsconversationidrating","deprecated":true},{"title":"/beta/search/conversations","summary":"Search conversations","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/conversations/getsearchconversations","deprecated":true}]}]}]}]}},{"type":"group","label":"Messages","link":"/openapi/dixa-api/beta/messages","routeSlug":"/openapi/dixa-api/beta/messages","items":[{"label":"Anonymize message","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize","routeSlug":"/openapi/dixa-api/beta/messages/patchconversationsconversationidmessagesmessageidanonymize","metadata":{"seo":{"title":"Anonymize message","description":"Request the anonymization of a single message in a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchConversationsConversationidMessagesMessageidAnonymize","name":"Anonymize message","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Anonymize message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Request the anonymization of a single message in a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["anonymization"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","description":"the id of the conversation in which the message belongs","required":true},{"name":"messageId","in":"path","schemaId":"schema_79","description":"the id of the message to anonymize","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"messageId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["anonymization"]}],"responseCodes":["202","400","404","409","500"],"pointer":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","href":"messages/patchconversationsconversationidmessagesmessageidanonymize","openApiOperationId":"patchConversationsConversationidMessagesMessageidAnonymize","summary":"Anonymize message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The message's anonymization request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]}},"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter messageId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]},{"code":"404","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}},"schemaId":"components/schemas/NotFound"},{"code":"409","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}},"schemaId":"components/schemas/ServerError"}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AnonymizeEntityOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound"}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/patchconversationsconversationidmessagesmessageidanonymize"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize"},{"label":"List messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/messages/getconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/messages/getconversationsconversationidmessages","metadata":{"seo":{"title":"List messages","description":"Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm conversations can have attributes of \"_type\": \"EmailAttributes\" if they are created through a webform, or \"_type\": \"ContactFormAttributes\" when created through a chat widget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidMessages","name":"List messages","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get all messages for a particular conversation by providing the conversation id. Note that messages in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ContactForm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" conversations can have attributes of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"_type\": \"EmailAttributes\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if they are created through a webform, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"_type\": \"ContactFormAttributes\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when created through a chat widget."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/messages","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/beta/conversations/{conversationId}/messages","href":"messages/getconversationsconversationidmessages","openApiOperationId":"getConversationsConversationidMessages","summary":"List messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of messages for a conversation sorted from oldest to newest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"]}},"schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMessagesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example","paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/getconversationsconversationidmessages"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages"},{"label":"Add message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/messages/postconversationsconversationidmessages","routeSlug":"/openapi/dixa-api/beta/messages/postconversationsconversationidmessages","metadata":{"seo":{"title":"Add message","description":"Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. If attachments are added to the message, they will be copied and stored in Dixa.  Content in outbound message is required except for Whatsapp messages.  Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only).  Supported Markdown syntax for Markdown content: bold **text**, italic *text*, bold & italic ***text***, strikethrough ~text~, blockquote  > Quoted text. \\n Message about quoted text, ordered list List:\\n1. Item\\n2. Item\\n3. Item, unordered list List:\\n* Item\\n* Item\\n* Item, inline code This is `code`.  Whatsapp channel:  Only one attachment is allowed per WhatsApp message.  Supports adding a message with attachment only (no content).  Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidMessages","name":"Add message","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If attachments are added to the message, they will be copied and stored in Dixa. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Content in outbound message is required except for Whatsapp messages. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported channels are Chat, Messenger, Contact Form, Email, Sms (outbound only), Whatsapp (outbound and Markdown only). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supported Markdown syntax for Markdown content: bold "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"**text**"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", italic "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"*text*"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", bold & italic "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"***text***"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", strikethrough "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"~text~"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", blockquote "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > Quoted text. \\n Message about quoted text"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ordered list "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List:\\n1. Item\\n2. Item\\n3. Item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", unordered list "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List:\\n* Item\\n* Item\\n* Item"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", inline code "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is `code`"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Whatsapp channel: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Only one attachment is allowed per WhatsApp message. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supports adding a message with attachment only (no content). "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Supports the following file types for attachments: .jpg, .jpeg, .png, .pdf, .doc, .docx, .pptx, .xlsx"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"]}},"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody","description":"The message to be added to a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/messages","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/messages","href":"messages/postconversationsconversationidmessages","openApiOperationId":"postConversationsConversationidMessages","summary":"Add message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateMessageInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound","paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The added message","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateMessageOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/messages/postconversationsconversationidmessages"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/messages"}],"content":{"contentType":"group","meta":{"name":"Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Messages","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/conversations/{conversationId}/messages/{messageId}/anonymize","summary":"Anonymize message","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/messages/patchconversationsconversationidmessagesmessageidanonymize","deprecated":false},{"title":"/beta/conversations/{conversationId}/messages","summary":"List messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/messages/getconversationsconversationidmessages","deprecated":false},{"title":"/beta/conversations/{conversationId}/messages","summary":"Add message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/messages/postconversationsconversationidmessages","deprecated":false}]}]}]}]}},{"type":"group","label":"Internal Notes","link":"/openapi/dixa-api/beta/internal-notes","routeSlug":"/openapi/dixa-api/beta/internal-notes","items":[{"label":"Add internal notes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotesbulk","routeSlug":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotesbulk","metadata":{"seo":{"title":"Add internal notes","description":"Create internal notes in a conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidNotesBulk","name":"Add internal notes","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add internal notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create internal notes in a conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"]}},"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody","description":"The list of internal notes to create for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/notes/bulk","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/notes/bulk","href":"internal-notes/postconversationsconversationidnotesbulk","openApiOperationId":"postConversationsConversationidNotesBulk","summary":"Add internal notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkCreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The created internal notes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"]}},"schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkCreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-notes/postconversationsconversationidnotesbulk"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/notes/bulk"},{"label":"List internal notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/internal-notes/getconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/internal-notes/getconversationsconversationidnotes","metadata":{"seo":{"title":"List internal notes","description":"Get all internal notes for a particular conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidNotes","name":"List internal notes","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List internal notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all internal notes for a particular conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/notes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/notes","href":"internal-notes/getconversationsconversationidnotes","openApiOperationId":"getConversationsConversationidNotes","summary":"List internal notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of internal notes for a conversation sorted from oldest to newest","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInternalNotesOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-notes/getconversationsconversationidnotes"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/notes"},{"label":"Add internal note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotes","routeSlug":"/openapi/dixa-api/beta/internal-notes/postconversationsconversationidnotes","metadata":{"seo":{"title":"Add internal note","description":"Create an internal note in a conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidNotes","name":"Add internal note","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add internal note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create an internal note in a conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.reply"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"]}},"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody","description":"The internal note to create for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/notes","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.reply"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/notes","href":"internal-notes/postconversationsconversationidnotes","openApiOperationId":"postConversationsConversationidNotes","summary":"Add internal note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateInternalNoteInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt","paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The created internal note","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"]}},"schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateNoteOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/internal-notes/postconversationsconversationidnotes"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/notes"}],"content":{"contentType":"group","meta":{"name":"Internal Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Internal Notes","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/conversations/{conversationId}/notes/bulk","summary":"Add internal notes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal-notes/postconversationsconversationidnotesbulk","deprecated":false},{"title":"/beta/conversations/{conversationId}/notes","summary":"List internal notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/internal-notes/getconversationsconversationidnotes","deprecated":false},{"title":"/beta/conversations/{conversationId}/notes","summary":"Add internal note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/internal-notes/postconversationsconversationidnotes","deprecated":false}]}]}]}]}},{"type":"group","label":"Ratings","link":"/openapi/dixa-api/beta/ratings","routeSlug":"/openapi/dixa-api/beta/ratings","items":[{"label":"Create conversation rating result","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit","routeSlug":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsratingidsubmit","metadata":{"seo":{"title":"Create conversation rating result","description":"Create a rating result for a specific conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidRatingsRatingidSubmit","name":"Create conversation rating result","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation rating result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rating result for a specific conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.satisfaction"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"ratingId","in":"path","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ratingId parameter has to be the ID of the offer created via invoking the /conversations/{conversationId}/ratings/offer endpoint."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody","description":"The rating result to be created for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"ratingId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.satisfaction"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","href":"ratings/postconversationsconversationidratingsratingidsubmit","openApiOperationId":"postConversationsConversationidRatingsRatingidSubmit","summary":"Create conversation rating result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingResultInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created conversation rating result","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingResultOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ratings/postconversationsconversationidratingsratingidsubmit"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit"},{"label":"Create conversation rating offer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer","routeSlug":"/openapi/dixa-api/beta/ratings/postconversationsconversationidratingsoffer","metadata":{"seo":{"title":"Create conversation rating offer","description":"Create a rating offer for a specific conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidRatingsOffer","name":"Create conversation rating offer","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create conversation rating offer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a rating offer for a specific conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.satisfaction"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody","description":"The rating offer to be created for a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/ratings/offer","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.satisfaction"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/conversations/{conversationId}/ratings/offer","href":"ratings/postconversationsconversationidratingsoffer","openApiOperationId":"postConversationsConversationidRatingsOffer","summary":"Create conversation rating offer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created conversation rating offer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateRatingOfferOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ratings/postconversationsconversationidratingsoffer"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings/offer"},{"label":"List ratings for a conversation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/getconversationsconversationidratings","routeSlug":"/openapi/dixa-api/beta/ratings/getconversationsconversationidratings","metadata":{"seo":{"title":"List ratings for a conversation","description":"Lists latest ratings statuses for a particular conversation by providing the conversation ID. For surveys with multiple questions, rating status will be reported for each individual question of the survey. For example, a response for a 3 question survey that was answered will be 3 elements with status \"Rated\". Additionally, a multiple question survey can be partially answered, therefore a response of such case will be a mix of \"Offered\" and \"Rated\" statuses. Note that the IDs of multiple questions response elements will be the same, because they are part of the same survey."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidRatings","name":"List ratings for a conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List ratings for a conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/ratings","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/ratings","href":"ratings/getconversationsconversationidratings","openApiOperationId":"getConversationsConversationidRatings","summary":"List ratings for a conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ratings for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"]}},"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered","paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ratings/getconversationsconversationidratings"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/ratings"},{"label":"List rating","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/ratings/getconversationsconversationidrating","routeSlug":"/openapi/dixa-api/beta/ratings/getconversationsconversationidrating","metadata":{"seo":{"title":"List rating","description":"Deprecated rating endpoint. Use '/ratings'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidRating","name":"List rating","deprecated":true,"isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1rating/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List rating","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deprecated rating endpoint. Use '/ratings'."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1rating/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/rating","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/rating","href":"ratings/getconversationsconversationidrating","openApiOperationId":"getConversationsConversationidRating","summary":"List rating"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of ratings for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1rating/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListConversationRatingsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ratings/getconversationsconversationidrating"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/rating"}],"content":{"contentType":"group","meta":{"name":"Ratings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ratings","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/conversations/{conversationId}/ratings/{ratingId}/submit","summary":"Create conversation rating result","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ratings/postconversationsconversationidratingsratingidsubmit","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings/offer","summary":"Create conversation rating offer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ratings/postconversationsconversationidratingsoffer","deprecated":false},{"title":"/beta/conversations/{conversationId}/ratings","summary":"List ratings for a conversation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ratings/getconversationsconversationidratings","deprecated":false},{"title":"/beta/conversations/{conversationId}/rating","summary":"List rating","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/ratings/getconversationsconversationidrating","deprecated":true}]}]}]}]}},{"type":"group","label":"Tags","link":"/openapi/dixa-api/beta/tags","routeSlug":"/openapi/dixa-api/beta/tags","items":[{"label":"Tag conversation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/putconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/tags/putconversationsconversationidtagstagid","metadata":{"seo":{"title":"Tag conversation","description":"Tag a conversation. You may only use active tags to tag conversations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putConversationsConversationidTagsTagid","name":"Tag conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Tag a conversation. You may only use active tags to tag conversations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"tagId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/beta/conversations/{conversationId}/tags/{tagId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags/{tagId}","href":"tags/putconversationsconversationidtagstagid","openApiOperationId":"putConversationsConversationidTagsTagid","summary":"Tag conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully tagged"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/putconversationsconversationidtagstagid"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}"},{"label":"Untag conversation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/deleteconversationsconversationidtagstagid","routeSlug":"/openapi/dixa-api/beta/tags/deleteconversationsconversationidtagstagid","metadata":{"seo":{"title":"Untag conversation","description":"Untag a conversation. You may remove active or inactive tags from a conversation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteConversationsConversationidTagsTagid","name":"Untag conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Untag conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Untag a conversation. You may remove active or inactive tags from a conversation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true},{"name":"tagId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/conversations/{conversationId}/tags/{tagId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"},{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags/{tagId}","href":"tags/deleteconversationsconversationidtagstagid","openApiOperationId":"deleteConversationsConversationidTagsTagid","summary":"Untag conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The conversation was successfully untagged"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deleteconversationsconversationidtagstagid"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags/{tagId}"},{"label":"Bulk tag conversation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/postconversationsconversationidtagsbulk","routeSlug":"/openapi/dixa-api/beta/tags/postconversationsconversationidtagsbulk","metadata":{"seo":{"title":"Bulk tag conversation","description":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postConversationsConversationidTagsBulk","name":"Bulk tag conversation","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk tag conversation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Initiate bulk tag of a conversation and process it asynchronously. If a tag with corresponding name does not exist it will be created."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["conversation.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody","description":"The list of tags to add to a conversation"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/conversations/{conversationId}/tags/bulk","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["conversation.tag"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags/bulk","href":"tags/postconversationsconversationidtagsbulk","openApiOperationId":"postConversationsConversationidTagsBulk","summary":"Bulk tag conversation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkTagConversationInput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"The conversation bulk tag was initiated"},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/postconversationsconversationidtagsbulk"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags/bulk"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/getconversationsconversationidtags","routeSlug":"/openapi/dixa-api/beta/tags/getconversationsconversationidtags","metadata":{"seo":{"title":"List tags","description":"Get the tags for a particular conversation by providing the conversation id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConversationsConversationidTags","name":"List tags","isWebhook":false,"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the tags for a particular conversation by providing the conversation id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"conversationId","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/conversations/{conversationId}/tags","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"conversationId","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/conversations/{conversationId}/tags","href":"tags/getconversationsconversationidtags","openApiOperationId":"getConversationsConversationidTags","summary":"List tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of tags for a conversation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter conversationId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1conversations~1{conversationId}~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConversationTagsOutput","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/getconversationsconversationidtags"}],"panels":[]}]},"httpPath":"/beta/conversations/{conversationId}/tags"},{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/gettags","routeSlug":"/openapi/dixa-api/beta/tags/gettags","metadata":{"seo":{"title":"List tags","description":"List all tags in an organization. Only active tags are returned by default. To include deactivated tags use ?includeDeactivated=true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTags","name":"List tags","isWebhook":false,"pointer":"/paths/~1beta~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all tags in an organization. Only active tags are returned by default. To include deactivated tags use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?includeDeactivated=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeDeactivated","in":"query","schemaId":"schema_80","description":"Whether to include deactivated tags in the response. If not provided, only active tags are listed."}],"pointer":"/paths/~1beta~1tags/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/tags","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"includeDeactivated","in":"query","required":false,"schemaId":"schema_80"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/tags","href":"tags/gettags","openApiOperationId":"getTags","summary":"List tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of all tags in an organization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTagsOutput","exampleIds":["paths/~1beta~1tags/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListTagsOutput","exampleIds":["paths/~1beta~1tags/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter includeDeactivated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTagsOutput","exampleIds":["paths/~1beta~1tags/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTagsOutput","exampleIds":["paths/~1beta~1tags/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettags"}],"panels":[]}]},"httpPath":"/beta/tags"},{"label":"Create tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/posttags","routeSlug":"/openapi/dixa-api/beta/tags/posttags","metadata":{"seo":{"title":"Create tag","description":"Create a tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postTags","name":"Create tag","isWebhook":false,"pointer":"/paths/~1beta~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTagInput","exampleIds":["paths/~1beta~1tags/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTagInput","exampleIds":["paths/~1beta~1tags/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1tags/post/requestBody","description":"The tag details"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/tags","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.tag"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTagInput","exampleIds":["paths/~1beta~1tags/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/tags","href":"tags/posttags","openApiOperationId":"postTags","summary":"Create tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateTagInput","exampleIds":["paths/~1beta~1tags/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTagInput","exampleIds":["paths/~1beta~1tags/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"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.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTagOutput","exampleIds":["paths/~1beta~1tags/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateTagOutput","exampleIds":["paths/~1beta~1tags/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateTagOutput","exampleIds":["paths/~1beta~1tags/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateTagOutput","exampleIds":["paths/~1beta~1tags/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/posttags"}],"panels":[]}]},"httpPath":"/beta/tags"},{"label":"Get tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/gettagstagid","routeSlug":"/openapi/dixa-api/beta/tags/gettagstagid","metadata":{"seo":{"title":"Get tag","description":"Get a tag by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTagsTagid","name":"Get tag","isWebhook":false,"pointer":"/paths/~1beta~1tags~1{tagId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a tag by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1tags~1{tagId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/tags/{tagId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/tags/{tagId}","href":"tags/gettagstagid","openApiOperationId":"getTagsTagid","summary":"Get tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The tag","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTagOutput","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetTagOutput","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1tags~1{tagId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetTagOutput","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetTagOutput","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/gettagstagid"}],"panels":[]}]},"httpPath":"/beta/tags/{tagId}"},{"label":"Delete tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/deletetagstagid","routeSlug":"/openapi/dixa-api/beta/tags/deletetagstagid","metadata":{"seo":{"title":"Delete tag","description":"Deletes the tag and all its associations. Note that this operation is irreversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTagsTagid","name":"Delete tag","isWebhook":false,"pointer":"/paths/~1beta~1tags~1{tagId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the tag and all its associations. Note that this operation is irreversible."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagId","in":"path","schemaId":"schema_79","description":"The tag id","required":true}],"pointer":"/paths/~1beta~1tags~1{tagId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/tags/{tagId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/tags/{tagId}","href":"tags/deletetagstagid","openApiOperationId":"deleteTagsTagid","summary":"Delete tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The tag was successfully deleted"},{"code":"400","description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1tags~1{tagId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/deletetagstagid"}],"panels":[]}]},"httpPath":"/beta/tags/{tagId}"},{"label":"Deactivate tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/patchtagstagiddeactivate","routeSlug":"/openapi/dixa-api/beta/tags/patchtagstagiddeactivate","metadata":{"seo":{"title":"Deactivate tag","description":"Deactivate a tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTagsTagidDeactivate","name":"Deactivate tag","isWebhook":false,"pointer":"/paths/~1beta~1tags~1{tagId}~1deactivate/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deactivate a tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagId","in":"path","schemaId":"schema_79","description":"The tag id","required":true}],"pointer":"/paths/~1beta~1tags~1{tagId}~1deactivate/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/tags/{tagId}/deactivate","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/tags/{tagId}/deactivate","href":"tags/patchtagstagiddeactivate","openApiOperationId":"patchTagsTagidDeactivate","summary":"Deactivate tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The tag was successfully deactivated"},{"code":"400","description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/patchtagstagiddeactivate"}],"panels":[]}]},"httpPath":"/beta/tags/{tagId}/deactivate"},{"label":"Activate tag","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/tags/patchtagstagidactivate","routeSlug":"/openapi/dixa-api/beta/tags/patchtagstagidactivate","metadata":{"seo":{"title":"Activate tag","description":"Activate a tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchTagsTagidActivate","name":"Activate tag","isWebhook":false,"pointer":"/paths/~1beta~1tags~1{tagId}~1activate/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Activate a tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.tag"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagId","in":"path","schemaId":"schema_79","description":"The tag id","required":true}],"pointer":"/paths/~1beta~1tags~1{tagId}~1activate/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/tags/{tagId}/activate","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"tagId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.tag"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/tags/{tagId}/activate","href":"tags/patchtagstagidactivate","openApiOperationId":"patchTagsTagidActivate","summary":"Activate tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The tag was successfully activated"},{"code":"400","description":"Invalid value for: path parameter tagId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1tags~1{tagId}~1activate/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1tags~1{tagId}~1activate/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/patchtagstagidactivate"}],"panels":[]}]},"httpPath":"/beta/tags/{tagId}/activate"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/conversations/{conversationId}/tags/{tagId}","summary":"Tag conversation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/putconversationsconversationidtagstagid","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags/{tagId}","summary":"Untag conversation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deleteconversationsconversationidtagstagid","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags/bulk","summary":"Bulk tag conversation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/postconversationsconversationidtagsbulk","deprecated":false},{"title":"/beta/conversations/{conversationId}/tags","summary":"List tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/getconversationsconversationidtags","deprecated":false},{"title":"/beta/tags","summary":"List tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettags","deprecated":false},{"title":"/beta/tags","summary":"Create tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/posttags","deprecated":false},{"title":"/beta/tags/{tagId}","summary":"Get tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/gettagstagid","deprecated":false},{"title":"/beta/tags/{tagId}","summary":"Delete tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetagstagid","deprecated":false},{"title":"/beta/tags/{tagId}/deactivate","summary":"Deactivate tag","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tags/patchtagstagiddeactivate","deprecated":false},{"title":"/beta/tags/{tagId}/activate","summary":"Activate tag","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/tags/patchtagstagidactivate","deprecated":false}]}]}]}]}},{"type":"group","label":"Queues","link":"/openapi/dixa-api/beta/queues","routeSlug":"/openapi/dixa-api/beta/queues","items":[{"label":"List queues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueues","routeSlug":"/openapi/dixa-api/beta/queues/getqueues","metadata":{"seo":{"title":"List queues","description":"List all queues in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueues","name":"List queues","isWebhook":false,"pointer":"/paths/~1beta~1queues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List queues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all queues in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","500"],"pointer":"/beta/queues","href":"queues/getqueues","openApiOperationId":"getQueues","summary":"List queues"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of queues in an organization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListQueuesOutput","exampleIds":["paths/~1beta~1queues/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListQueuesOutput","exampleIds":["paths/~1beta~1queues/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListQueuesOutput","exampleIds":["paths/~1beta~1queues/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListQueuesOutput","exampleIds":["paths/~1beta~1queues/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/getqueues"}],"panels":[]}]},"httpPath":"/beta/queues"},{"label":"Create queue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/postqueues","routeSlug":"/openapi/dixa-api/beta/queues/postqueues","metadata":{"seo":{"title":"Create queue","description":"Create a queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postQueues","name":"Create queue","isWebhook":false,"pointer":"/paths/~1beta~1queues/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create queue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateQueueInput","exampleIds":["paths/~1beta~1queues/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateQueueInput","exampleIds":["paths/~1beta~1queues/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1queues/post/requestBody","description":"The details for creating a queue"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/queues","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:w"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateQueueInput","exampleIds":["paths/~1beta~1queues/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/queues","href":"queues/postqueues","openApiOperationId":"postQueues","summary":"Create queue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateQueueInput","exampleIds":["paths/~1beta~1queues/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateQueueInput","exampleIds":["paths/~1beta~1queues/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateQueueOutput"}},"schemaId":"components/schemas/CreateQueueOutput"},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateQueueOutput","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateQueueOutput"}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/postqueues"}],"panels":[]}]},"httpPath":"/beta/queues"},{"label":"List agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesqueueidmembers","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesqueueidmembers","metadata":{"seo":{"title":"List agents","description":"List all agents/admins that are members of a queue by providing the queue id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueuesQueueidMembers","name":"List agents","isWebhook":false,"pointer":"/paths/~1beta~1queues~1{queueId}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all agents/admins that are members of a queue by providing the queue id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues/{queueId}/members","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"queueId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/queues/{queueId}/members","href":"queues/getqueuesqueueidmembers","openApiOperationId":"getQueuesQueueidMembers","summary":"List agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of the agents/admins that are members of a queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueueMembersOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/QueueMembersOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter queueId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueueMembersOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueueMembersOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/getqueuesqueueidmembers"}],"panels":[]}]},"httpPath":"/beta/queues/{queueId}/members"},{"label":"Remove agents","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/deletequeuesqueueidmembers","routeSlug":"/openapi/dixa-api/beta/queues/deletequeuesqueueidmembers","metadata":{"seo":{"title":"Remove agents","description":"Bulk remove agents/admins from the specified queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteQueuesQueueidMembers","name":"Remove agents","isWebhook":false,"pointer":"/paths/~1beta~1queues~1{queueId}~1members/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Bulk remove agents/admins from the specified queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue.members"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/delete/requestBody","description":"The list of agents/admins to be removed from the queue. Up to 10 members can be specified."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/queues/{queueId}/members","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"queueId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue.members"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example"]}},"responseCodes":["204","400","404","500"],"pointer":"/beta/queues/{queueId}/members","href":"queues/deletequeuesqueueidmembers","openApiOperationId":"deleteQueuesQueueidMembers","summary":"Remove agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The bulk operation succeeded"},{"code":"400","description":"Invalid value for: path parameter queueId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/deletequeuesqueueidmembers"}],"panels":[]}]},"httpPath":"/beta/queues/{queueId}/members"},{"label":"Assign agents","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/patchqueuesqueueidmembers","routeSlug":"/openapi/dixa-api/beta/queues/patchqueuesqueueidmembers","metadata":{"seo":{"title":"Assign agents","description":"Assign one or more agents/admins to a given queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchQueuesQueueidMembers","name":"Assign agents","isWebhook":false,"pointer":"/paths/~1beta~1queues~1{queueId}~1members/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Assign one or more agents/admins to a given queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue.members"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/patch/requestBody","description":"The list of agents/admins to be added to the queue"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/queues/{queueId}/members","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"queueId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue.members"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/queues/{queueId}/members","href":"queues/patchqueuesqueueidmembers","openApiOperationId":"patchQueuesQueueidMembers","summary":"Assign agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointInput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of patch action outcomes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/BulkQueueEndpointOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter queueId, Invalid value extracted from request context, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1{queueId}~1members/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkQueueEndpointOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkQueueEndpointOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1members/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/patchqueuesqueueidmembers"}],"panels":[]}]},"httpPath":"/beta/queues/{queueId}/members"},{"label":"Get queue availability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesqueueidavailability","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesqueueidavailability","metadata":{"seo":{"title":"Get queue availability","description":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueuesQueueidAvailability","name":"Get queue availability","isWebhook":false,"pointer":"/paths/~1beta~1queues~1{queueId}~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get queue availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get availability of supported channels for a given queue. Currently supported channels are adachat, kindlychat, digitalgeniuschat, genericapimessaging."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1queues~1{queueId}~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues/{queueId}/availability","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"queueId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","409","500"],"pointer":"/beta/queues/{queueId}/availability","href":"queues/getqueuesqueueidavailability","openApiOperationId":"getQueuesQueueidAvailability","summary":"Get queue availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The availability of supported channels for a given queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter queueId, Invalid value extracted from request context ,queue does not exist","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"]},{"code":"409","description":"The request could not be completed due to no supported channels configured for this organization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}},"schemaId":"components/schemas/Conflict"},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1{queueId}~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/QueueAvailabilityOutput","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Conflict"}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/getqueuesqueueidavailability"}],"panels":[]}]},"httpPath":"/beta/queues/{queueId}/availability"},{"label":"Get queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesqueueid","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesqueueid","metadata":{"seo":{"title":"Get queue","description":"Get a queue by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueuesQueueid","name":"Get queue","isWebhook":false,"pointer":"/paths/~1beta~1queues~1{queueId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get queue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a queue by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1queues~1{queueId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues/{queueId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"queueId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/queues/{queueId}","href":"queues/getqueuesqueueid","openApiOperationId":"getQueuesQueueid","summary":"Get queue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueueByIdOutput","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetQueueByIdOutput","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter queueId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1{queueId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetQueueByIdOutput","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueueByIdOutput","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1{queueId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/getqueuesqueueid"}],"panels":[]}]},"httpPath":"/beta/queues/{queueId}"},{"label":"Get the position of the conversation in its current queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/queues/getqueuesconversation-positioncsid","routeSlug":"/openapi/dixa-api/beta/queues/getqueuesconversation-positioncsid","metadata":{"seo":{"title":"Get the position of the conversation in its current queue","description":"Get the approximate position of a given conversation in its current queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueuesConversation-positionCsid","name":"Get the position of the conversation in its current queue","isWebhook":false,"pointer":"/paths/~1beta~1queues~1conversation-position~1{csid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the position of the conversation in its current queue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the approximate position of a given conversation in its current queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.queue:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"csid","in":"path","schemaId":"schema_81","required":true}],"pointer":"/paths/~1beta~1queues~1conversation-position~1{csid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/queues/conversation-position/{csid}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"csid","in":"path","required":true,"schemaId":"schema_81"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.queue:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/queues/conversation-position/{csid}","href":"queues/getqueuesconversation-positioncsid","openApiOperationId":"getQueuesConversation-positionCsid","summary":"Get the position of the conversation in its current queue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The position of the conversation in the queue","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter csid, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1queues~1conversation-position~1{csid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetQueuedConversationPositionOutput","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/queues/getqueuesconversation-positioncsid"}],"panels":[]}]},"httpPath":"/beta/queues/conversation-position/{csid}"}],"content":{"contentType":"group","meta":{"name":"Queues"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queues","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/queues","summary":"List queues","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queues/getqueues","deprecated":false},{"title":"/beta/queues","summary":"Create queue","prefix":{"name":"post","color":"post"},"badges":[],"link":"/queues/postqueues","deprecated":false},{"title":"/beta/queues/{queueId}/members","summary":"List agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queues/getqueuesqueueidmembers","deprecated":false},{"title":"/beta/queues/{queueId}/members","summary":"Remove agents","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/queues/deletequeuesqueueidmembers","deprecated":false},{"title":"/beta/queues/{queueId}/members","summary":"Assign agents","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/queues/patchqueuesqueueidmembers","deprecated":false},{"title":"/beta/queues/{queueId}/availability","summary":"Get queue availability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queues/getqueuesqueueidavailability","deprecated":false},{"title":"/beta/queues/{queueId}","summary":"Get queue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queues/getqueuesqueueid","deprecated":false},{"title":"/beta/queues/conversation-position/{csid}","summary":"Get the position of the conversation in its current queue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/queues/getqueuesconversation-positioncsid","deprecated":false}]}]}]}]}},{"type":"group","label":"Contact Endpoints","link":"/openapi/dixa-api/beta/contact-endpoints","routeSlug":"/openapi/dixa-api/beta/contact-endpoints","items":[{"label":"Get contact endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpointscontactendpointid","routeSlug":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpointscontactendpointid","metadata":{"seo":{"title":"Get contact endpoint","description":"Get contact endpoint by id (email or phone number)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContact-endpointsContactendpointid","name":"Get contact endpoint","isWebhook":false,"pointer":"/paths/~1beta~1contact-endpoints~1{contactEndpointId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contact endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get contact endpoint by id (email or phone number)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"contactEndpointId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/contact-endpoints/{contactEndpointId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"contactEndpointId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404"],"pointer":"/beta/contact-endpoints/{contactEndpointId}","href":"contact-endpoints/getcontact-endpointscontactendpointid","openApiOperationId":"getContact-endpointsContactendpointid","summary":"Get contact endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The requested contact endpoint","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetContactPointByIdOutput","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetContactPointByIdOutput","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, The contactEndpointId is neither a valid email nor a valid E.164 phone number","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/404/content/application~1json/example"]}],"pointer":"/paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetContactPointByIdOutput","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetContactPointByIdOutput","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/404/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-endpoints/getcontact-endpointscontactendpointid"}],"panels":[]}]},"httpPath":"/beta/contact-endpoints/{contactEndpointId}"},{"label":"List contact endpoints","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpoints","routeSlug":"/openapi/dixa-api/beta/contact-endpoints/getcontact-endpoints","metadata":{"seo":{"title":"List contact endpoints","description":"List all available contact endpoints in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContact-endpoints","name":"List contact endpoints","isWebhook":false,"pointer":"/paths/~1beta~1contact-endpoints/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contact endpoints","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all available contact endpoints in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"_type","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional contact type can be specified to filter the contact endpoints. If not provided, all types are listed. Possible values: [EmailEndpoint, TelephonyEndpoint]"},"children":[]}]}]}]}],"pointer":"/paths/~1beta~1contact-endpoints/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/contact-endpoints","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"_type","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/contact-endpoints","href":"contact-endpoints/getcontact-endpoints","openApiOperationId":"getContact-endpoints","summary":"List contact endpoints"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of available contact endpoints","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactPointsOutput","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListContactPointsOutput","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/200/content/application~1json/example"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid value extracted from request context, Invalid value for: query parameter _type"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1contact-endpoints/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListContactPointsOutput","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListContactPointsOutput","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1contact-endpoints/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contact-endpoints/getcontact-endpoints"}],"panels":[]}]},"httpPath":"/beta/contact-endpoints"}],"content":{"contentType":"group","meta":{"name":"Contact Endpoints"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contact Endpoints","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/contact-endpoints/{contactEndpointId}","summary":"Get contact endpoint","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-endpoints/getcontact-endpointscontactendpointid","deprecated":false},{"title":"/beta/contact-endpoints","summary":"List contact endpoints","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contact-endpoints/getcontact-endpoints","deprecated":false}]}]}]}]}},{"type":"group","label":"Search","link":"/openapi/dixa-api/beta/search","routeSlug":"/openapi/dixa-api/beta/search","items":[{"label":"Search conversations with filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/search/postsearchconversations","routeSlug":"/openapi/dixa-api/beta/search/postsearchconversations","metadata":{"seo":{"title":"Search conversations with filters","description":"Search for conversations containing a particular text or by filter or combine them both"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postSearchConversations","name":"Search conversations with filters","isWebhook":false,"pointer":"/paths/~1beta~1search~1conversations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search conversations with filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search for conversations containing a particular text or by filter or combine them both"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1search~1conversations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"]}},"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"],"pointer":"/paths/~1beta~1search~1conversations/post/requestBody","description":"The filters to apply to the search"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/search/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"]}},"responseCodes":["200","400","401","500"],"pointer":"/beta/search/conversations","href":"search/postsearchconversations","openApiOperationId":"postSearchConversations","summary":"Search conversations with filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SearchParametersInput","exampleIds":["paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps","paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The search results for the searched parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"]}},"schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1search~1conversations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchConversationsWithFiltersOutput","exampleIds":["paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available","paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/postsearchconversations"}],"panels":[]}]},"httpPath":"/beta/search/conversations"},{"label":"Search conversations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/search/getsearchconversations","routeSlug":"/openapi/dixa-api/beta/search/getsearchconversations","metadata":{"seo":{"title":"Search conversations","description":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSearchConversations","name":"Search conversations","deprecated":true,"isWebhook":false,"pointer":"/paths/~1beta~1search~1conversations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search conversations","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"NOTE: This endpoint is deprecated and is replaced with POST /search/conversations. Search for conversations containing a particular text."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."},{"name":"query","in":"query","schemaId":"schema_83","description":"The text by which to search conversations","required":true,"example":"cancel my order"},{"name":"exactMatch","in":"query","schemaId":"schema_84","description":"Return only exact matches. This value is false by default."}],"pointer":"/paths/~1beta~1search~1conversations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/search/conversations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"},{"name":"query","in":"query","required":true,"example":"cancel my order","schemaId":"schema_83"},{"name":"exactMatch","in":"query","required":false,"schemaId":"schema_84"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/beta/search/conversations","href":"search/getsearchconversations","openApiOperationId":"getSearchConversations","summary":"Search conversations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The search results for the searched parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"]},{"code":"401","description":"The user who issued the access token used in the request is not authorized to perform the operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1search~1conversations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SearchOutput","exampleIds":["paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized","exampleIds":["paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/search/getsearchconversations"}],"panels":[]}]},"httpPath":"/beta/search/conversations"}],"content":{"contentType":"group","meta":{"name":"Search"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/search/conversations","summary":"Search conversations with filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/search/postsearchconversations","deprecated":false},{"title":"/beta/search/conversations","summary":"Search conversations","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/search/getsearchconversations","deprecated":true}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/openapi/dixa-api/beta/webhooks","routeSlug":"/openapi/dixa-api/beta/webhooks","items":[{"label":"Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Webhook Subscription","description":"Get a Webhook Subscription by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhooksWebhooksubscriptionid","name":"Webhook Subscription","isWebhook":false,"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a Webhook Subscription by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/webhooks/{webhookSubscriptionId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/webhooks/{webhookSubscriptionId}","href":"webhooks/getwebhookswebhooksubscriptionid","openApiOperationId":"getWebhooksWebhooksubscriptionid","summary":"Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Webhook Subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhookswebhooksubscriptionid"}],"panels":[]}]},"httpPath":"/beta/webhooks/{webhookSubscriptionId}"},{"label":"Delete Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/deletewebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/beta/webhooks/deletewebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Delete Webhook Subscription","description":"Delete a Webhook Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhooksWebhooksubscriptionid","name":"Delete Webhook Subscription","isWebhook":false,"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Webhook Subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.integration.api"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/webhooks/{webhookSubscriptionId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.integration.api"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/webhooks/{webhookSubscriptionId}","href":"webhooks/deletewebhookswebhooksubscriptionid","openApiOperationId":"deleteWebhooksWebhooksubscriptionid","summary":"Delete Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The Webhook Subscription was successfully deleted"},{"code":"400","description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhookswebhooksubscriptionid"}],"panels":[]}]},"httpPath":"/beta/webhooks/{webhookSubscriptionId}"},{"label":"Patch Webhook Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/patchwebhookswebhooksubscriptionid","routeSlug":"/openapi/dixa-api/beta/webhooks/patchwebhookswebhooksubscriptionid","metadata":{"seo":{"title":"Patch Webhook Subscription","description":"Patch a Webhook Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWebhooksWebhooksubscriptionid","name":"Patch Webhook Subscription","isWebhook":false,"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Patch a Webhook Subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.integration.api"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PatchWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody","description":"The Webhook Subscription fields to be patched"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/webhooks/{webhookSubscriptionId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.integration.api"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","500"],"pointer":"/beta/webhooks/{webhookSubscriptionId}","href":"webhooks/patchwebhookswebhooksubscriptionid","openApiOperationId":"patchWebhooksWebhooksubscriptionid","summary":"Patch Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/PatchWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The patched Webhook Subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatchWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context, Invalid value for: body, Validation failure during Webhook Subscription patching","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/patchwebhookswebhooksubscriptionid"}],"panels":[]}]},"httpPath":"/beta/webhooks/{webhookSubscriptionId}"},{"label":"List all Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhooks","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhooks","metadata":{"seo":{"title":"List all Webhook Subscriptions","description":"List of all Webhook Subscriptions in an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhooks","name":"List all Webhook Subscriptions","isWebhook":false,"pointer":"/paths/~1beta~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Webhook Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of all Webhook Subscriptions in an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/webhooks","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/webhooks","href":"webhooks/getwebhooks","openApiOperationId":"getWebhooks","summary":"List all Webhook Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The List of Webhook Subscriptions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWebhookSubscriptionsEndpointOutput","exampleIds":["paths/~1beta~1webhooks/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListWebhookSubscriptionsEndpointOutput","exampleIds":["paths/~1beta~1webhooks/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListWebhookSubscriptionsEndpointOutput","exampleIds":["paths/~1beta~1webhooks/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWebhookSubscriptionsEndpointOutput","exampleIds":["paths/~1beta~1webhooks/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhooks"}],"panels":[]}]},"httpPath":"/beta/webhooks"},{"label":"Create Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/postwebhooks","routeSlug":"/openapi/dixa-api/beta/webhooks/postwebhooks","metadata":{"seo":{"title":"Create Webhook Subscription","description":"Create a Webhook Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postWebhooks","name":"Create Webhook Subscription","isWebhook":false,"pointer":"/paths/~1beta~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Webhook Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Webhook Subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.integration.api"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1webhooks/post/requestBody","description":"The Webhook Subscription to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/webhooks","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.integration.api"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","500"],"pointer":"/beta/webhooks","href":"webhooks/postwebhooks","openApiOperationId":"postWebhooks","summary":"Create Webhook Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionInput","exampleIds":["paths/~1beta~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created Webhook Subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks/post/responses/201/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context, Invalid value for: body, Validation failure during Webhook Subscription creation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebhookSubscriptionOutput","exampleIds":["paths/~1beta~1webhooks/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/postwebhooks"}],"panels":[]}]},"httpPath":"/beta/webhooks"},{"label":"Webhook Subscription Last Delivery Statuses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-status","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-status","metadata":{"seo":{"title":"Webhook Subscription Last Delivery Statuses","description":"Get the latest delivery statuses of a Webhook Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhooksWebhooksubscriptionidDelivery-status","name":"Webhook Subscription Last Delivery Statuses","isWebhook":false,"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Subscription Last Delivery Statuses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the latest delivery statuses of a Webhook Subscription."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/webhooks/{webhookSubscriptionId}/delivery-status","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/webhooks/{webhookSubscriptionId}/delivery-status","href":"webhooks/getwebhookswebhooksubscriptioniddelivery-status","openApiOperationId":"getWebhooksWebhooksubscriptionidDelivery-status","summary":"Webhook Subscription Last Delivery Statuses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Latest Delivery Statuses of a Webhook Subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookLastDeliveryStatusOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetWebhookLastDeliveryStatusOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWebhookLastDeliveryStatusOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookLastDeliveryStatusOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhookswebhooksubscriptioniddelivery-status"}],"panels":[]}]},"httpPath":"/beta/webhooks/{webhookSubscriptionId}/delivery-status"},{"label":"Webhook Subscription Event Logs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","routeSlug":"/openapi/dixa-api/beta/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","metadata":{"seo":{"title":"Webhook Subscription Event Logs","description":"Get the latest Webhook Subscription Event logs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhooksWebhooksubscriptionidDelivery-statusLogsEvent","name":"Webhook Subscription Event Logs","isWebhook":false,"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Subscription Event Logs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the latest Webhook Subscription Event logs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhookSubscriptionId","in":"path","schemaId":"schema_79","required":true},{"name":"event","in":"path","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"webhookSubscriptionId","in":"path","required":true,"schemaId":"schema_79"},{"name":"event","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}","href":"webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","openApiOperationId":"getWebhooksWebhooksubscriptionidDelivery-statusLogsEvent","summary":"Webhook Subscription Event Logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Webhook Subscription Event Logs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookEventDeliveryLogsOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetWebhookEventDeliveryLogsOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter webhookSubscriptionId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWebhookEventDeliveryLogsOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWebhookEventDeliveryLogsOutput","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent"}],"panels":[]}]},"httpPath":"/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/webhooks/{webhookSubscriptionId}","summary":"Webhook Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhookswebhooksubscriptionid","deprecated":false},{"title":"/beta/webhooks/{webhookSubscriptionId}","summary":"Delete Webhook Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhookswebhooksubscriptionid","deprecated":false},{"title":"/beta/webhooks/{webhookSubscriptionId}","summary":"Patch Webhook Subscription","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/patchwebhookswebhooksubscriptionid","deprecated":false},{"title":"/beta/webhooks","summary":"List all Webhook Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhooks","deprecated":false},{"title":"/beta/webhooks","summary":"Create Webhook Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/postwebhooks","deprecated":false},{"title":"/beta/webhooks/{webhookSubscriptionId}/delivery-status","summary":"Webhook Subscription Last Delivery Statuses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhookswebhooksubscriptioniddelivery-status","deprecated":false},{"title":"/beta/webhooks/{webhookSubscriptionId}/delivery-status/logs/{event}","summary":"Webhook Subscription Event Logs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhookswebhooksubscriptioniddelivery-statuslogsevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Templates","link":"/openapi/dixa-api/beta/templates","routeSlug":"/openapi/dixa-api/beta/templates","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/templates/gettemplates","routeSlug":"/openapi/dixa-api/beta/templates/gettemplates","metadata":{"seo":{"title":"List templates","description":"Lists all templates belonging to an organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTemplates","name":"List templates","isWebhook":false,"pointer":"/paths/~1beta~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all templates belonging to an organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."},{"name":"type","in":"query","schemaId":"schema_85","description":"Filter by template type","example":"QuickResponse"}],"pointer":"/paths/~1beta~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/templates","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"},{"name":"type","in":"query","required":false,"example":"QuickResponse","schemaId":"schema_85"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/templates","href":"templates/gettemplates","openApiOperationId":"getTemplates","summary":"List templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of templates in an organization","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTemplatesOutput","exampleIds":["paths/~1beta~1templates/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListTemplatesOutput","exampleIds":["paths/~1beta~1templates/get/responses/200/content/application~1json/example"]},{"code":"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListTemplatesOutput","exampleIds":["paths/~1beta~1templates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListTemplatesOutput","exampleIds":["paths/~1beta~1templates/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/gettemplates"}],"panels":[]}]},"httpPath":"/beta/templates"},{"label":"Delete template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/templates/deletetemplatestemplateid","routeSlug":"/openapi/dixa-api/beta/templates/deletetemplatestemplateid","metadata":{"seo":{"title":"Delete template","description":"Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTemplatesTemplateid","name":"Delete template","isWebhook":false,"pointer":"/paths/~1beta~1templates~1{templateId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the template. Please make sure the template is not used in flows and automations as this operation is irreversible."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["settings.template"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateId","in":"path","schemaId":"schema_79","description":"The template id","required":true}],"pointer":"/paths/~1beta~1templates~1{templateId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/templates/{templateId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"templateId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["settings.template"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/templates/{templateId}","href":"templates/deletetemplatestemplateid","openApiOperationId":"deleteTemplatesTemplateid","summary":"Delete template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The template was successfully deleted"},{"code":"400","description":"Invalid value for: path parameter templateId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1templates~1{templateId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1templates~1{templateId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/deletetemplatestemplateid"}],"panels":[]}]},"httpPath":"/beta/templates/{templateId}"}],"content":{"contentType":"group","meta":{"name":"Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/templates","summary":"List templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/gettemplates","deprecated":false},{"title":"/beta/templates/{templateId}","summary":"Delete template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/templates/deletetemplatestemplateid","deprecated":false}]}]}]}]}},{"type":"group","label":"Business Hours","link":"/openapi/dixa-api/beta/business-hours","routeSlug":"/openapi/dixa-api/beta/business-hours","items":[{"label":"List business hours schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedules","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedules","metadata":{"seo":{"title":"List business hours schedules","description":"List business hours schedules in an organization with pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusiness-hoursSchedules","name":"List business hours schedules","isWebhook":false,"pointer":"/paths/~1beta~1business-hours~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List business hours schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List business hours schedules in an organization with pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/business-hours/schedules","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/business-hours/schedules","href":"business-hours/getbusiness-hoursschedules","openApiOperationId":"getBusiness-hoursSchedules","summary":"List business hours schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBusinessHoursSchedulesOutput","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListBusinessHoursSchedulesOutput","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1business-hours~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBusinessHoursSchedulesOutput","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBusinessHoursSchedulesOutput","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-hours/getbusiness-hoursschedules"}],"panels":[]}]},"httpPath":"/beta/business-hours/schedules"},{"label":"Get a business hours schedule definition.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleiddefinition","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleiddefinition","metadata":{"seo":{"title":"Get a business hours schedule definition.","description":"Get a business hours schedule definition in an organization by providing its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusiness-hoursSchedulesScheduleidDefinition","name":"Get a business hours schedule definition.","isWebhook":false,"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a business hours schedule definition.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a business hours schedule definition in an organization by providing its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/business-hours/schedules/{scheduleId}/definition","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/business-hours/schedules/{scheduleId}/definition","href":"business-hours/getbusiness-hoursschedulesscheduleiddefinition","openApiOperationId":"getBusiness-hoursSchedulesScheduleidDefinition","summary":"Get a business hours schedule definition."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBusinessHoursScheduleDefinitionOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetBusinessHoursScheduleDefinitionOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value for: path parameter scheduleId, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBusinessHoursScheduleDefinitionOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBusinessHoursScheduleDefinitionOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-hours/getbusiness-hoursschedulesscheduleiddefinition"}],"panels":[]}]},"httpPath":"/beta/business-hours/schedules/{scheduleId}/definition"},{"label":"Get the upcoming business hours schedule.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidupcoming","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidupcoming","metadata":{"seo":{"title":"Get the upcoming business hours schedule.","description":"Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions. Each entry in businessHours describes one upcoming day (see its nextDate). An entry with status: Open lists the intervals during which the business is open on that day; between and outside those intervals it is closed. An entry with status: Closed is a day explicitly configured as closed and has no intervals. Days without any configured business hours are omitted from the response entirely, so businessHours can be empty when no day in the requested window has configured hours. In short: the business is open only during the intervals of status: Open entries, and closed at all other times."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusiness-hoursSchedulesScheduleidUpcoming","name":"Get the upcoming business hours schedule.","isWebhook":false,"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the upcoming business hours schedule.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the resolved business hours schedule for the next number of days, applying recurring rules and exceptions. Each entry in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describes one upcoming day (see its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). An entry with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: Open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists the intervals during which the business is open on that day; between and outside those intervals it is closed. An entry with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: Closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a day explicitly configured as closed and has no intervals. Days without any configured business hours are omitted from the response entirely, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"businessHours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be empty when no day in the requested window has configured hours. In short: the business is open only during the intervals of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: Open"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries, and closed at all other times."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"days","in":"query","schemaId":"schema_86","description":"Number of upcoming days to include in the response. Must be between 1 and 90."}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/business-hours/schedules/{scheduleId}/upcoming","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"days","in":"query","required":false,"schemaId":"schema_86"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/business-hours/schedules/{scheduleId}/upcoming","href":"business-hours/getbusiness-hoursschedulesscheduleidupcoming","openApiOperationId":"getBusiness-hoursSchedulesScheduleidUpcoming","summary":"Get the upcoming business hours schedule."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUpcomingBusinessHoursScheduleOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Days open with a single interval","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Split hours (closed 12:00-13:00) and an explicitly closed day","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/No day in the requested window has configured hours"]}},"schemaId":"components/schemas/GetUpcomingBusinessHoursScheduleOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Days open with a single interval","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Split hours (closed 12:00-13:00) and an explicitly closed day","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/No day in the requested window has configured hours"]},{"code":"400","description":"Invalid value for: path parameter scheduleId, Invalid value for: query parameter days, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetUpcomingBusinessHoursScheduleOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Days open with a single interval","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Split hours (closed 12:00-13:00) and an explicitly closed day","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/No day in the requested window has configured hours"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetUpcomingBusinessHoursScheduleOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Days open with a single interval","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Split hours (closed 12:00-13:00) and an explicitly closed day","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/No day in the requested window has configured hours"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-hours/getbusiness-hoursschedulesscheduleidupcoming"}],"panels":[]}]},"httpPath":"/beta/business-hours/schedules/{scheduleId}/upcoming"},{"label":"Check if a business is open","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidstatus","routeSlug":"/openapi/dixa-api/beta/business-hours/getbusiness-hoursschedulesscheduleidstatus","metadata":{"seo":{"title":"Check if a business is open","description":"Check if a business is open either right now or at the specified timestamp. When the business is open, closesAt holds the end of the current open interval and opensAt is null. When it is closed, opensAt holds the start of the next open interval — if there is one within the next year — and closesAt is null."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusiness-hoursSchedulesScheduleidStatus","name":"Check if a business is open","isWebhook":false,"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check if a business is open","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check if a business is open either right now or at the specified timestamp. When the business is open, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closesAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the end of the current open interval and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opensAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null. When it is closed, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opensAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the start of the next open interval — if there is one within the next year — and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closesAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is null."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"scheduleId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timestamp","in":"query","schemaId":"schema_82","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."}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/business-hours/schedules/{scheduleId}/status","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"scheduleId","in":"path","required":true,"schemaId":"schema_75"}],"query":[{"name":"timestamp","in":"query","required":false,"schemaId":"schema_82"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/business-hours/schedules/{scheduleId}/status","href":"business-hours/getbusiness-hoursschedulesscheduleidstatus","openApiOperationId":"getBusiness-hoursSchedulesScheduleidStatus","summary":"Check if a business is open"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business hours status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBusinessOpenStatusOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Open, closes at 17:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, next opening at 09:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, no opening within the next year"]}},"schemaId":"components/schemas/GetBusinessOpenStatusOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Open, closes at 17:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, next opening at 09:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, no opening within the next year"]},{"code":"400","description":"Invalid value for: query parameter timestamp, Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetBusinessOpenStatusOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Open, closes at 17:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, next opening at 09:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, no opening within the next year"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetBusinessOpenStatusOutput","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Open, closes at 17:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, next opening at 09:00","paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, no opening within the next year"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-hours/getbusiness-hoursschedulesscheduleidstatus"}],"panels":[]}]},"httpPath":"/beta/business-hours/schedules/{scheduleId}/status"}],"content":{"contentType":"group","meta":{"name":"Business Hours"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Hours","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/business-hours/schedules","summary":"List business hours schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-hours/getbusiness-hoursschedules","deprecated":false},{"title":"/beta/business-hours/schedules/{scheduleId}/definition","summary":"Get a business hours schedule definition.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-hours/getbusiness-hoursschedulesscheduleiddefinition","deprecated":false},{"title":"/beta/business-hours/schedules/{scheduleId}/upcoming","summary":"Get the upcoming business hours schedule.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-hours/getbusiness-hoursschedulesscheduleidupcoming","deprecated":false},{"title":"/beta/business-hours/schedules/{scheduleId}/status","summary":"Check if a business is open","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-hours/getbusiness-hoursschedulesscheduleidstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Knowledge","link":"/openapi/dixa-api/beta/knowledge","routeSlug":"/openapi/dixa-api/beta/knowledge","items":[{"label":"Get collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionid","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionid","metadata":{"seo":{"title":"Get collection","description":"Get a knowledge collection by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeCollectionsCollectionid","name":"Get collection","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a knowledge collection by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.collections:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/collections/{collectionId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.collections:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/collections/{collectionId}","href":"knowledge/getknowledgecollectionscollectionid","openApiOperationId":"getKnowledgeCollectionsCollectionid","summary":"Get collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The knowledge collection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCollectionOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetKnowledgeCollectionOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKnowledgeCollectionOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCollectionOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgecollectionscollectionid"}],"panels":[]}]},"httpPath":"/beta/knowledge/collections/{collectionId}"},{"label":"Get collection catalog","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionidcatalog","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecollectionscollectionidcatalog","metadata":{"seo":{"title":"Get collection catalog","description":"Get collection catalog, including all categories and articles"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeCollectionsCollectionidCatalog","name":"Get collection catalog","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get collection catalog","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get collection catalog, including all categories and articles"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.collections:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_75","description":"Language in which the article translations will be returned. If not provided, the default language will be used."}],"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/collections/{collectionId}/catalog","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"language","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.collections:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/collections/{collectionId}/catalog","href":"knowledge/getknowledgecollectionscollectionidcatalog","openApiOperationId":"getKnowledgeCollectionsCollectionidCatalog","summary":"Get collection catalog"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The knowledge collection catalog","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCollectionCatalogOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetKnowledgeCollectionCatalogOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKnowledgeCollectionCatalogOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCollectionCatalogOutput","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgecollectionscollectionidcatalog"}],"panels":[]}]},"httpPath":"/beta/knowledge/collections/{collectionId}/catalog"},{"label":"Get category","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryid","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryid","metadata":{"seo":{"title":"Get category","description":"Get a knowledge category by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeCategoriesCategoryid","name":"Get category","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a knowledge category by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_75","description":"Language in which the article translations will be returned. If not provided, the default language will be used."}],"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/categories/{categoryId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"categoryId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"language","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/categories/{categoryId}","href":"knowledge/getknowledgecategoriescategoryid","openApiOperationId":"getKnowledgeCategoriesCategoryid","summary":"Get category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The category","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCategoryOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetKnowledgeCategoryOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKnowledgeCategoryOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCategoryOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgecategoriescategoryid"}],"panels":[]}]},"httpPath":"/beta/knowledge/categories/{categoryId}"},{"label":"Get category translations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryidtranslations","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecategoriescategoryidtranslations","metadata":{"seo":{"title":"Get category translations","description":"Get the knowledge category translations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeCategoriesCategoryidTranslations","name":"Get category translations","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get category translations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the knowledge category translations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"categoryId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/categories/{categoryId}/translations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"categoryId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/categories/{categoryId}/translations","href":"knowledge/getknowledgecategoriescategoryidtranslations","openApiOperationId":"getKnowledgeCategoriesCategoryidTranslations","summary":"Get category translations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The category translations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCategoryTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetKnowledgeCategoryTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKnowledgeCategoryTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeCategoryTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgecategoriescategoryidtranslations"}],"panels":[]}]},"httpPath":"/beta/knowledge/categories/{categoryId}/translations"},{"label":"Get article","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleid","metadata":{"seo":{"title":"Get article","description":"Get a knowledge article by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeArticlesArticleid","name":"Get article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a knowledge article by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"language","in":"query","schemaId":"schema_75","description":"Language in which the article translations will be returned. If not provided, the default language will be used."}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/articles/{articleId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[{"name":"language","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}","href":"knowledge/getknowledgearticlesarticleid","openApiOperationId":"getKnowledgeArticlesArticleid","summary":"Get article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The knowledge article","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgearticlesarticleid"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}"},{"label":"Delete article","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleid","metadata":{"seo":{"title":"Delete article","description":"Delete a knowledge article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteKnowledgeArticlesArticleid","name":"Delete article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a knowledge article"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/knowledge/articles/{articleId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}","href":"knowledge/deleteknowledgearticlesarticleid","openApiOperationId":"deleteKnowledgeArticlesArticleid","summary":"Delete article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/deleteknowledgearticlesarticleid"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}"},{"label":"Update article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleid","routeSlug":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleid","metadata":{"seo":{"title":"Update article","description":"Update a knowledge article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchKnowledgeArticlesArticleid","name":"Update article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a knowledge article"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody","description":"The knowledge article fields to update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/knowledge/articles/{articleId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}","href":"knowledge/patchknowledgearticlesarticleid","openApiOperationId":"patchKnowledgeArticlesArticleid","summary":"Update article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/UpdateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated knowledge article","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/patchknowledgearticlesarticleid"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}"},{"label":"Get article translations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleidtranslations","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgearticlesarticleidtranslations","metadata":{"seo":{"title":"Get article translations","description":"Get a knowledge article translations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeArticlesArticleidTranslations","name":"Get article translations","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get article translations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a knowledge article translations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/articles/{articleId}/translations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/translations","href":"knowledge/getknowledgearticlesarticleidtranslations","openApiOperationId":"getKnowledgeArticlesArticleidTranslations","summary":"Get article translations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The article translations","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeArticleTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetKnowledgeArticleTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetKnowledgeArticleTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetKnowledgeArticleTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgearticlesarticleidtranslations"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/translations"},{"label":"Update article translations","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidtranslations","routeSlug":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidtranslations","metadata":{"seo":{"title":"Update article translations","description":"Update translations for a knowledge article. Supports partial success."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchKnowledgeArticlesArticleidTranslations","name":"Update article translations","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update article translations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update translations for a knowledge article. Supports partial success."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTranslationsInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateTranslationsInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody","description":"The translations to update for the article"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/knowledge/articles/{articleId}/translations","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateTranslationsInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/translations","href":"knowledge/patchknowledgearticlesarticleidtranslations","openApiOperationId":"patchKnowledgeArticlesArticleidTranslations","summary":"Update article translations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/UpdateTranslationsInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateTranslationsInput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The updated translations, with partial errors if any","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UpdateTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UpdateTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateTranslationsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/patchknowledgearticlesarticleidtranslations"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/translations"},{"label":"Create article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticles","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticles","metadata":{"seo":{"title":"Create article","description":"Create a knowledge article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postKnowledgeArticles","name":"Create article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a knowledge article"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CreateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1knowledge~1articles/post/requestBody","description":"The knowledge article to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/knowledge/articles","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/articles","href":"knowledge/postknowledgearticles","openApiOperationId":"postKnowledgeArticles","summary":"Create article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateKnowledgeArticleInput","exampleIds":["paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The created knowledge article","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/CreateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateKnowledgeArticleOutput","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/postknowledgearticles"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles"},{"label":"Publish translation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","metadata":{"seo":{"title":"Publish translation","description":"Publish a specific translation for search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postKnowledgeArticlesArticleidTranslationsLanguageidPublish","name":"Publish translation","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish translation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Publish a specific translation for search"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true},{"name":"languageId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/knowledge/articles/{articleId}/translations/{languageId}/publish","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"},{"name":"languageId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/translations/{languageId}/publish","href":"knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","openApiOperationId":"postKnowledgeArticlesArticleidTranslationsLanguageidPublish","summary":"Publish translation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/translations/{languageId}/publish"},{"label":"Unpublish translation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","metadata":{"seo":{"title":"Unpublish translation","description":"Mark a specific translation as unpublished"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postKnowledgeArticlesArticleidTranslationsLanguageidUnpublish","name":"Unpublish translation","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpublish translation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a specific translation as unpublished"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true},{"name":"languageId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/knowledge/articles/{articleId}/translations/{languageId}/unpublish","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"},{"name":"languageId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/translations/{languageId}/unpublish","href":"knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","openApiOperationId":"postKnowledgeArticlesArticleidTranslationsLanguageidUnpublish","summary":"Unpublish translation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/translations/{languageId}/unpublish"},{"label":"Delete article translation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","routeSlug":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","metadata":{"seo":{"title":"Delete article translation","description":"Delete all versions of a knowledge article translation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteKnowledgeArticlesArticleidTranslationsLanguageid","name":"Delete article translation","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete article translation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete all versions of a knowledge article translation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true},{"name":"languageId","in":"path","schemaId":"schema_75","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/knowledge/articles/{articleId}/translations/{languageId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"},{"name":"languageId","in":"path","required":true,"schemaId":"schema_75"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/translations/{languageId}","href":"knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","openApiOperationId":"deleteKnowledgeArticlesArticleidTranslationsLanguageid","summary":"Delete article translation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/translations/{languageId}"},{"label":"Publish article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidpublish","metadata":{"seo":{"title":"Publish article","description":"Publish a new version of all translations for a knowledge article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postKnowledgeArticlesArticleidPublish","name":"Publish article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Publish a new version of all translations for a knowledge article"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/knowledge/articles/{articleId}/publish","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/publish","href":"knowledge/postknowledgearticlesarticleidpublish","openApiOperationId":"postKnowledgeArticlesArticleidPublish","summary":"Publish article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/postknowledgearticlesarticleidpublish"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/publish"},{"label":"Unpublish article","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidunpublish","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesarticleidunpublish","metadata":{"seo":{"title":"Unpublish article","description":"Remove all translations of a knowledge article from search"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postKnowledgeArticlesArticleidUnpublish","name":"Unpublish article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unpublish article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove all translations of a knowledge article from search"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/knowledge/articles/{articleId}/unpublish","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/unpublish","href":"knowledge/postknowledgearticlesarticleidunpublish","openApiOperationId":"postKnowledgeArticlesArticleidUnpublish","summary":"Unpublish article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/postknowledgearticlesarticleidunpublish"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/unpublish"},{"label":"Move article","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidparentparentid","routeSlug":"/openapi/dixa-api/beta/knowledge/patchknowledgearticlesarticleidparentparentid","metadata":{"seo":{"title":"Move article","description":"Move a knowledge article to a new parent"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchKnowledgeArticlesArticleidParentParentid","name":"Move article","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move article","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Move a knowledge article to a new parent"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true},{"name":"parentId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/beta/knowledge/articles/{articleId}/parent/{parentId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"},{"name":"parentId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/parent/{parentId}","href":"knowledge/patchknowledgearticlesarticleidparentparentid","openApiOperationId":"patchKnowledgeArticlesArticleidParentParentid","summary":"Move article"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/patchknowledgearticlesarticleidparentparentid"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/parent/{parentId}"},{"label":"Remove article parent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidparent","routeSlug":"/openapi/dixa-api/beta/knowledge/deleteknowledgearticlesarticleidparent","metadata":{"seo":{"title":"Remove article parent","description":"Remove a parent from a knowledge article"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteKnowledgeArticlesArticleidParent","name":"Remove article parent","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove article parent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a parent from a knowledge article"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"articleId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/beta/knowledge/articles/{articleId}/parent","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"articleId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"responseCodes":["204","400","404","500"],"pointer":"/beta/knowledge/articles/{articleId}/parent","href":"knowledge/deleteknowledgearticlesarticleidparent","openApiOperationId":"deleteKnowledgeArticlesArticleidParent","summary":"Remove article parent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204"},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/deleteknowledgearticlesarticleidparent"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/{articleId}/parent"},{"label":"List collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/getknowledgecollections","routeSlug":"/openapi/dixa-api/beta/knowledge/getknowledgecollections","metadata":{"seo":{"title":"List collections","description":"Paginated list knowledge collections"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getKnowledgeCollections","name":"List collections","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List collections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Paginated list knowledge collections"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.collections:r"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1knowledge~1collections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/knowledge/collections","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.collections:r"]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/knowledge/collections","href":"knowledge/getknowledgecollections","openApiOperationId":"getKnowledgeCollections","summary":"List collections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of knowledge collections","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListKnowledgeCollectionsOutput","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListKnowledgeCollectionsOutput","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListKnowledgeCollectionsOutput","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListKnowledgeCollectionsOutput","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1collections/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/getknowledgecollections"}],"panels":[]}]},"httpPath":"/beta/knowledge/collections"},{"label":"Upload article attachments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesattachments","routeSlug":"/openapi/dixa-api/beta/knowledge/postknowledgearticlesattachments","metadata":{"seo":{"title":"Upload article attachments","description":"Upload one or more image files to be used as attachments in knowledge articles. Supported formats: image/png, image/jpeg, image/gif, image/webp. Maximum 5 files per request, 4 MB per file, with a total request payload limit of 10 MB. Supports partial success."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postKnowledgeArticlesAttachments","name":"Upload article attachments","isWebhook":false,"pointer":"/paths/~1beta~1knowledge~1articles~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload article attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"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."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":["knowledge.content:w"],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UploadAttachmentsInput"}},"schemaId":"components/schemas/UploadAttachmentsInput","pointer":"/paths/~1beta~1knowledge~1articles~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/knowledge/articles/attachments","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":["knowledge.content:w"]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/UploadAttachmentsInput"}},"responseCodes":["200","400","500"],"pointer":"/beta/knowledge/articles/attachments","href":"knowledge/postknowledgearticlesattachments","openApiOperationId":"postKnowledgeArticlesAttachments","summary":"Upload article attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/UploadAttachmentsInput","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UploadAttachmentsInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The uploaded attachments, with partial errors if any","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadAttachmentsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/All succeeded","paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/Partial success"]}},"schemaId":"components/schemas/UploadAttachmentsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/All succeeded","paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/Partial success"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1knowledge~1articles~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadAttachmentsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/All succeeded","paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/Partial success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadAttachmentsOutput","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/All succeeded","paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/Partial success"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1knowledge~1articles~1attachments/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/knowledge/postknowledgearticlesattachments"}],"panels":[]}]},"httpPath":"/beta/knowledge/articles/attachments"}],"content":{"contentType":"group","meta":{"name":"Knowledge"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Knowledge","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/knowledge/collections/{collectionId}","summary":"Get collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgecollectionscollectionid","deprecated":false},{"title":"/beta/knowledge/collections/{collectionId}/catalog","summary":"Get collection catalog","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgecollectionscollectionidcatalog","deprecated":false},{"title":"/beta/knowledge/categories/{categoryId}","summary":"Get category","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgecategoriescategoryid","deprecated":false},{"title":"/beta/knowledge/categories/{categoryId}/translations","summary":"Get category translations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgecategoriescategoryidtranslations","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}","summary":"Get article","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgearticlesarticleid","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}","summary":"Delete article","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/knowledge/deleteknowledgearticlesarticleid","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}","summary":"Update article","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/knowledge/patchknowledgearticlesarticleid","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/translations","summary":"Get article translations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgearticlesarticleidtranslations","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/translations","summary":"Update article translations","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/knowledge/patchknowledgearticlesarticleidtranslations","deprecated":false},{"title":"/beta/knowledge/articles","summary":"Create article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/knowledge/postknowledgearticles","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/translations/{languageId}/publish","summary":"Publish translation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/knowledge/postknowledgearticlesarticleidtranslationslanguageidpublish","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/translations/{languageId}/unpublish","summary":"Unpublish translation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/knowledge/postknowledgearticlesarticleidtranslationslanguageidunpublish","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/translations/{languageId}","summary":"Delete article translation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/knowledge/deleteknowledgearticlesarticleidtranslationslanguageid","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/publish","summary":"Publish article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/knowledge/postknowledgearticlesarticleidpublish","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/unpublish","summary":"Unpublish article","prefix":{"name":"post","color":"post"},"badges":[],"link":"/knowledge/postknowledgearticlesarticleidunpublish","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/parent/{parentId}","summary":"Move article","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/knowledge/patchknowledgearticlesarticleidparentparentid","deprecated":false},{"title":"/beta/knowledge/articles/{articleId}/parent","summary":"Remove article parent","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/knowledge/deleteknowledgearticlesarticleidparent","deprecated":false},{"title":"/beta/knowledge/collections","summary":"List collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/knowledge/getknowledgecollections","deprecated":false},{"title":"/beta/knowledge/articles/attachments","summary":"Upload article attachments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/knowledge/postknowledgearticlesattachments","deprecated":false}]}]}]}]}},{"type":"group","label":"Organization","link":"/openapi/dixa-api/beta/organization","routeSlug":"/openapi/dixa-api/beta/organization","items":[{"label":"Get organization details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/organization/getorganization","routeSlug":"/openapi/dixa-api/beta/organization/getorganization","metadata":{"seo":{"title":"Get organization details","description":"Retrieves information about the organization associated with the provided API token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganization","name":"Get organization details","isWebhook":false,"pointer":"/paths/~1beta~1organization/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves information about the organization associated with the provided API token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/organization","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/organization","href":"organization/getorganization","openApiOperationId":"getOrganization","summary":"Get organization details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The organization details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationOutput","exampleIds":["paths/~1beta~1organization/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetOrganizationOutput","exampleIds":["paths/~1beta~1organization/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid value extracted from request context","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1organization/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1organization/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1organization/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1organization/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1organization/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1organization/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1organization/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetOrganizationOutput","exampleIds":["paths/~1beta~1organization/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetOrganizationOutput","exampleIds":["paths/~1beta~1organization/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1organization/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1organization/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1organization/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1organization/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1organization/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1organization/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organization/getorganization"}],"panels":[]}]},"httpPath":"/beta/organization"}],"content":{"contentType":"group","meta":{"name":"Organization"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/organization","summary":"Get organization details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organization/getorganization","deprecated":false}]}]}]}]}},{"type":"group","label":"Commerce Events","link":"/openapi/dixa-api/beta/commerce-events","routeSlug":"/openapi/dixa-api/beta/commerce-events","items":[{"label":"Submit commerce event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/commerce-events/postcommerce-events","routeSlug":"/openapi/dixa-api/beta/commerce-events/postcommerce-events","metadata":{"seo":{"title":"Submit commerce event","description":"Submit a commerce event for a user (e.g. order lifecycle events for conversation routing, sales attribution, and analytics)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postCommerce-events","name":"Submit commerce event","isWebhook":false,"pointer":"/paths/~1beta~1commerce-events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit commerce event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submit a commerce event for a user (e.g. order lifecycle events for conversation routing, sales attribution, and analytics)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommerceEvent","exampleIds":["paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CommerceEvent","exampleIds":["paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1beta~1commerce-events/post/requestBody","description":"The commerce event to submit"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/commerce-events","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommerceEvent","exampleIds":["paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example"]}},"responseCodes":["202","400","404","500"],"pointer":"/beta/commerce-events","href":"commerce-events/postcommerce-events","openApiOperationId":"postCommerce-events","summary":"Submit commerce event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CommerceEvent","exampleIds":["paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommerceEvent","exampleIds":["paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Event accepted"},{"code":"400","description":"Invalid value for: body","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1commerce-events/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1commerce-events/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1commerce-events/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1commerce-events/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1commerce-events/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1commerce-events/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1commerce-events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1commerce-events/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1commerce-events/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1commerce-events/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1commerce-events/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1commerce-events/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1commerce-events/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/commerce-events/postcommerce-events"}],"panels":[]}]},"httpPath":"/beta/commerce-events"}],"content":{"contentType":"group","meta":{"name":"Commerce Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commerce Events","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/commerce-events","summary":"Submit commerce event","prefix":{"name":"post","color":"post"},"badges":[],"link":"/commerce-events/postcommerce-events","deprecated":false}]}]}]}]}},{"type":"group","label":"WhatsApp Templates","link":"/openapi/dixa-api/beta/whatsapp-templates","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates","items":[{"label":"Get WhatsApp template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplatestemplateid","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplatestemplateid","metadata":{"seo":{"title":"Get WhatsApp template","description":"Get a WhatsApp template by id with template's category and approval status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWhatsappTemplatesTemplateid","name":"Get WhatsApp template","isWebhook":false,"pointer":"/paths/~1beta~1whatsapp~1templates~1{templateId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get WhatsApp template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a WhatsApp template by id with template's category and approval status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"templateId","in":"path","schemaId":"schema_79","required":true}],"pointer":"/paths/~1beta~1whatsapp~1templates~1{templateId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/whatsapp/templates/{templateId}","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[{"name":"templateId","in":"path","required":true,"schemaId":"schema_79"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/beta/whatsapp/templates/{templateId}","href":"whatsapp-templates/getwhatsapptemplatestemplateid","openApiOperationId":"getWhatsappTemplatesTemplateid","summary":"Get WhatsApp template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The WhatsApp template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/GetWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/getwhatsapptemplatestemplateid"}],"panels":[]}]},"httpPath":"/beta/whatsapp/templates/{templateId}"},{"label":"List WhatsApp templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplates","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates/getwhatsapptemplates","metadata":{"seo":{"title":"List WhatsApp templates","description":"List WhatsApp templates for the organization, newest first. To find out a template's approval status and category, use the get template endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWhatsappTemplates","name":"List WhatsApp templates","isWebhook":false,"pointer":"/paths/~1beta~1whatsapp~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List WhatsApp templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List WhatsApp templates for the organization, newest first. To find out a template's approval status and category, use the get template endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageLimit","in":"query","schemaId":"schema_74","description":"Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."},{"name":"pageKey","in":"query","schemaId":"schema_75","description":"Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."}],"pointer":"/paths/~1beta~1whatsapp~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/beta/whatsapp/templates","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[{"name":"pageLimit","in":"query","required":false,"schemaId":"schema_74"},{"name":"pageKey","in":"query","required":false,"schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/beta/whatsapp/templates","href":"whatsapp-templates/getwhatsapptemplates","openApiOperationId":"getWhatsappTemplates","summary":"List WhatsApp templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The list of WhatsApp templates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWhatsappTemplatesOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/ListWhatsappTemplatesOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/200/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/400/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1whatsapp~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListWhatsappTemplatesOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWhatsappTemplatesOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/400/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/getwhatsapptemplates"}],"panels":[]}]},"httpPath":"/beta/whatsapp/templates"},{"label":"Create WhatsApp template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/dixa-api/beta/whatsapp-templates/postwhatsapptemplates","routeSlug":"/openapi/dixa-api/beta/whatsapp-templates/postwhatsapptemplates","metadata":{"seo":{"title":"Create WhatsApp template","description":"Create a new WhatsApp template. The template body is limited to 1024 characters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postWhatsappTemplates","name":"Create WhatsApp template","isWebhook":false,"pointer":"/paths/~1beta~1whatsapp~1templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create WhatsApp template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new WhatsApp template. The template body is limited to 1024 characters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateInput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template","paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Media template"]}},"schemaId":"components/schemas/CreateTemplateInput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template","paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Media template"],"pointer":"/paths/~1beta~1whatsapp~1templates/post/requestBody","description":"The WhatsApp template to create"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/beta/whatsapp/templates","servers":[{"url":"https://dev.dixa.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateTemplateInput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template","paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Media template"]}},"responseCodes":["201","400","404","500"],"pointer":"/beta/whatsapp/templates","href":"whatsapp-templates/postwhatsapptemplates","openApiOperationId":"postWhatsappTemplates","summary":"Create WhatsApp template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://dev.dixa.io"}],"schemaId":"components/schemas/CreateTemplateInput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template","paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Media template"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateTemplateInput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template","paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Media template"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The created WhatsApp template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/CreateWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/201/content/application~1json/example"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/400/content/application~1json/example"]},{"code":"404","description":"An entity in this request could not be found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/404/content/application~1json/example"]},{"code":"500","description":"Internal failure during request processing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1beta~1whatsapp~1templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CreateWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWhatsappTemplateOutput","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BadRequest","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/400/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFound","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/404/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerError","exampleIds":["paths/~1beta~1whatsapp~1templates/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/whatsapp-templates/postwhatsapptemplates"}],"panels":[]}]},"httpPath":"/beta/whatsapp/templates"}],"content":{"contentType":"group","meta":{"name":"WhatsApp Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"WhatsApp Templates","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/beta/whatsapp/templates/{templateId}","summary":"Get WhatsApp template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/whatsapp-templates/getwhatsapptemplatestemplateid","deprecated":false},{"title":"/beta/whatsapp/templates","summary":"List WhatsApp templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/whatsapp-templates/getwhatsapptemplates","deprecated":false},{"title":"/beta/whatsapp/templates","summary":"Create WhatsApp template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/whatsapp-templates/postwhatsapptemplates","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ActivityLogAttribute":{"id":"components/schemas/ActivityLogAttribute","kind":"json-schema","title":"ActivityLogAttribute","data":{"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/ConversationRatingNotOfferedAttribute"},{"$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"}]}},"components/schemas/ActivityLogEntry":{"id":"components/schemas/ActivityLogEntry","kind":"json-schema","title":"ActivityLogEntry","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"type":"string"},"author":{"$ref":"#/components/schemas/ActivityLogUser"},"attributes":{"$ref":"#/components/schemas/ActivityLogAttribute"}}}},"components/schemas/ActivityLogUser":{"id":"components/schemas/ActivityLogUser","kind":"json-schema","title":"ActivityLogUser","data":{"title":"ActivityLogUser","type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}}},"components/schemas/Ada":{"id":"components/schemas/Ada","kind":"json-schema","title":"Ada","data":{"title":"Ada","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Dixa user associated with the AI agent, used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a message"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/Agent":{"id":"components/schemas/Agent","kind":"json-schema","title":"Agent","data":{"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"}}}}},"components/schemas/AgentId":{"id":"components/schemas/AgentId","kind":"json-schema","title":"AgentId","data":{"title":"AgentId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldCanHaveSingleValueOrBeEmptyOperator"}}}},"components/schemas/AgentOutput":{"id":"components/schemas/AgentOutput","kind":"json-schema","title":"AgentOutput","data":{"title":"AgentOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Agent"}}}},"components/schemas/AgentPresenceDurationValue":{"id":"components/schemas/AgentPresenceDurationValue","kind":"json-schema","title":"AgentPresenceDurationValue","data":{"title":"AgentPresenceDurationValue","type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/PresenceDuration"}},"description":{"type":"string"}}}},"components/schemas/AgentTeamsOutput":{"id":"components/schemas/AgentTeamsOutput","kind":"json-schema","title":"AgentTeamsOutput","data":{"title":"AgentTeamsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Team"}}}}},"components/schemas/AgentsToTeamInput":{"id":"components/schemas/AgentsToTeamInput","kind":"json-schema","title":"AgentsToTeamInput","data":{"title":"AgentsToTeamInput","type":"object","properties":{"agentIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/AggregateMetadata":{"id":"components/schemas/AggregateMetadata","kind":"json-schema","title":"AggregateMetadata","data":{"title":"AggregateMetadata","type":"object","required":["measure"],"properties":{"measure":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]"},"children":[]}]}]}],"type":"string"},"description":{"type":"string"}}}},"components/schemas/AggregateValue":{"id":"components/schemas/AggregateValue","kind":"json-schema","title":"AggregateValue","data":{"title":"AggregateValue","oneOf":[{"$ref":"#/components/schemas/AgentPresenceDurationValue"},{"$ref":"#/components/schemas/DoubleAggregateValue"},{"$ref":"#/components/schemas/LongAggregateValue"}]}},"components/schemas/AiAgent":{"id":"components/schemas/AiAgent","kind":"json-schema","title":"AiAgent","data":{"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"}]}},"components/schemas/AnonymizationRequestStatus":{"id":"components/schemas/AnonymizationRequestStatus","kind":"json-schema","title":"AnonymizationRequestStatus","data":{"title":"AnonymizationRequestStatus","type":"object","required":["id","entityType","_type","initiatedAt","targetEntityId","requestedBy"],"properties":{"id":{"type":"string","format":"uuid"},"entityType":{"$ref":"#/components/schemas/DeprecatedAnonymizationType"},"_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Conversation, Message, User]"},"children":[]}]}]}],"type":"string"},"initiatedAt":{"type":"string","format":"date-time"},"targetEntityId":{"type":"string"},"requestedBy":{"type":"string","format":"uuid"},"processedAt":{"type":"string","format":"date-time"}}}},"components/schemas/AnonymizeEntityInput":{"id":"components/schemas/AnonymizeEntityInput","kind":"json-schema","title":"AnonymizeEntityInput","data":{"title":"AnonymizeEntityInput","type":"object","required":["entityId"],"properties":{"entityId":{"type":"string"},"entityType":{"$ref":"#/components/schemas/DeprecatedAnonymizationType"},"forceAnonymization":{"type":"boolean"},"_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Conversation, Message, User]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/AnonymizeEntityOutput":{"id":"components/schemas/AnonymizeEntityOutput","kind":"json-schema","title":"AnonymizeEntityOutput","data":{"title":"AnonymizeEntityOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AnonymizationRequestStatus"}}}},"components/schemas/AnonymizedConversation":{"id":"components/schemas/AnonymizedConversation","kind":"json-schema","title":"AnonymizedConversation","data":{"title":"AnonymizedConversation","type":"object","required":["id","requesterId","channel","createdAt","anonymizedAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/Article":{"id":"components/schemas/Article","kind":"json-schema","title":"Article","data":{"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"}}}}},"components/schemas/ArticleCatalogItem":{"id":"components/schemas/ArticleCatalogItem","kind":"json-schema","title":"ArticleCatalogItem","data":{"title":"ArticleCatalogItem","type":"object","required":["id"],"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/TranslationTitle"}}}},"components/schemas/ArticleContent":{"id":"components/schemas/ArticleContent","kind":"json-schema","title":"ArticleContent","data":{"title":"ArticleContent","type":"object","required":["html","plaintext"],"properties":{"html":{"type":"string"},"plaintext":{"type":"string"}}}},"components/schemas/ArticleTranslation":{"id":"components/schemas/ArticleTranslation","kind":"json-schema","title":"ArticleTranslation","data":{"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"}}}},"components/schemas/ArticleTranslations":{"id":"components/schemas/ArticleTranslations","kind":"json-schema","title":"ArticleTranslations","data":{"title":"ArticleTranslations","type":"object","required":["translations"],"properties":{"translations":{"$ref":"#/components/schemas/TranslationList"}}}},"components/schemas/AssignedDate":{"id":"components/schemas/AssignedDate","kind":"json-schema","title":"AssignedDate","data":{"title":"AssignedDate","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}}},"components/schemas/Assignment":{"id":"components/schemas/Assignment","kind":"json-schema","title":"Assignment","data":{"title":"Assignment","type":"object","required":["agentId","assignedAt"],"properties":{"agentId":{"type":"string","format":"uuid"},"assignedAt":{"type":"string","format":"date-time"}}}},"components/schemas/AttachmentError":{"id":"components/schemas/AttachmentError","kind":"json-schema","title":"AttachmentError","data":{"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"}}}},"components/schemas/AttachmentResult":{"id":"components/schemas/AttachmentResult","kind":"json-schema","title":"AttachmentResult","data":{"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"}}}},"components/schemas/Attachments":{"id":"components/schemas/Attachments","kind":"json-schema","title":"Attachments","data":{"title":"Attachments","type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/FileMeta"}}}}},"components/schemas/Attributes":{"id":"components/schemas/Attributes","kind":"json-schema","title":"Attributes","data":{"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"}]}},"components/schemas/AvailableAt":{"id":"components/schemas/AvailableAt","kind":"json-schema","title":"AvailableAt","data":{"title":"AvailableAt","type":"object","properties":{"helpCenterLinks":{"type":"array","items":{"$ref":"#/components/schemas/HelpCenterLink"}}}}},"components/schemas/BadRequest":{"id":"components/schemas/BadRequest","kind":"json-schema","title":"BadRequest","data":{"title":"BadRequest","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/BasicAuth":{"id":"components/schemas/BasicAuth","kind":"json-schema","title":"BasicAuth","data":{"title":"BasicAuth","type":"object","required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}}}},"components/schemas/Between":{"id":"components/schemas/Between","kind":"json-schema","title":"Between","data":{"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"}}}},"components/schemas/Between1":{"id":"components/schemas/Between1","kind":"json-schema","title":"Between","data":{"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"}}}},"components/schemas/BooleanField":{"id":"components/schemas/BooleanField","kind":"json-schema","title":"BooleanField","data":{"title":"BooleanField","type":"object","required":["value"],"properties":{"value":{"type":"boolean"}}}},"components/schemas/BrowserInfo":{"id":"components/schemas/BrowserInfo","kind":"json-schema","title":"BrowserInfo","data":{"title":"BrowserInfo","type":"object","required":["name"],"properties":{"name":{"type":"string"},"version":{"type":"string"},"ipAddress":{"type":"string"},"originatingUrl":{"type":"string"}}}},"components/schemas/BulkActionFailure_BulkError_Agent":{"id":"components/schemas/BulkActionFailure_BulkError_Agent","kind":"json-schema","title":"BulkActionFailure_BulkError_Agent","data":{"title":"BulkActionFailure_BulkError_Agent","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BulkError"}}}},"components/schemas/BulkActionFailure_BulkError_EndUser":{"id":"components/schemas/BulkActionFailure_BulkError_EndUser","kind":"json-schema","title":"BulkActionFailure_BulkError_EndUser","data":{"title":"BulkActionFailure_BulkError_EndUser","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BulkError"}}}},"components/schemas/BulkActionFailure_BulkError_UUID":{"id":"components/schemas/BulkActionFailure_BulkError_UUID","kind":"json-schema","title":"BulkActionFailure_BulkError_UUID","data":{"title":"BulkActionFailure_BulkError_UUID","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/BulkError"}}}},"components/schemas/BulkActionFailure_ErrorResponse_InternalNoteData":{"id":"components/schemas/BulkActionFailure_ErrorResponse_InternalNoteData","kind":"json-schema","title":"BulkActionFailure_ErrorResponse_InternalNoteData","data":{"title":"BulkActionFailure_ErrorResponse_InternalNoteData","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/ErrorResponse"}}}},"components/schemas/BulkActionOutcome_BulkError_Agent":{"id":"components/schemas/BulkActionOutcome_BulkError_Agent","kind":"json-schema","title":"BulkActionOutcome_BulkError_Agent","data":{"title":"BulkActionOutcome_BulkError_Agent","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_BulkError_Agent"},{"$ref":"#/components/schemas/BulkActionSuccess_BulkError_Agent"}]}},"components/schemas/BulkActionOutcome_BulkError_EndUser":{"id":"components/schemas/BulkActionOutcome_BulkError_EndUser","kind":"json-schema","title":"BulkActionOutcome_BulkError_EndUser","data":{"title":"BulkActionOutcome_BulkError_EndUser","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_BulkError_EndUser"},{"$ref":"#/components/schemas/BulkActionSuccess_BulkError_EndUser"}]}},"components/schemas/BulkActionOutcome_BulkError_UUID":{"id":"components/schemas/BulkActionOutcome_BulkError_UUID","kind":"json-schema","title":"BulkActionOutcome_BulkError_UUID","data":{"title":"BulkActionOutcome_BulkError_UUID","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_BulkError_UUID"},{"$ref":"#/components/schemas/BulkActionSuccess_BulkError_UUID"}]}},"components/schemas/BulkActionOutcome_ErrorResponse_InternalNoteData":{"id":"components/schemas/BulkActionOutcome_ErrorResponse_InternalNoteData","kind":"json-schema","title":"BulkActionOutcome_ErrorResponse_InternalNoteData","data":{"title":"BulkActionOutcome_ErrorResponse_InternalNoteData","oneOf":[{"$ref":"#/components/schemas/BulkActionFailure_ErrorResponse_InternalNoteData"},{"$ref":"#/components/schemas/BulkActionSuccess_ErrorResponse_InternalNoteData"}]}},"components/schemas/BulkActionSuccess_BulkError_Agent":{"id":"components/schemas/BulkActionSuccess_BulkError_Agent","kind":"json-schema","title":"BulkActionSuccess_BulkError_Agent","data":{"title":"BulkActionSuccess_BulkError_Agent","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Agent"}}}},"components/schemas/BulkActionSuccess_BulkError_EndUser":{"id":"components/schemas/BulkActionSuccess_BulkError_EndUser","kind":"json-schema","title":"BulkActionSuccess_BulkError_EndUser","data":{"title":"BulkActionSuccess_BulkError_EndUser","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}}},"components/schemas/BulkActionSuccess_BulkError_UUID":{"id":"components/schemas/BulkActionSuccess_BulkError_UUID","kind":"json-schema","title":"BulkActionSuccess_BulkError_UUID","data":{"title":"BulkActionSuccess_BulkError_UUID","type":"object","required":["data"],"properties":{"data":{"type":"string","format":"uuid"}}}},"components/schemas/BulkActionSuccess_ErrorResponse_InternalNoteData":{"id":"components/schemas/BulkActionSuccess_ErrorResponse_InternalNoteData","kind":"json-schema","title":"BulkActionSuccess_ErrorResponse_InternalNoteData","data":{"title":"BulkActionSuccess_ErrorResponse_InternalNoteData","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InternalNoteData"}}}},"components/schemas/BulkCreateInternalNoteInput":{"id":"components/schemas/BulkCreateInternalNoteInput","kind":"json-schema","title":"BulkCreateInternalNoteInput","data":{"title":"BulkCreateInternalNoteInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateInternalNoteInput"}}}}},"components/schemas/BulkCreateNoteOutput":{"id":"components/schemas/BulkCreateNoteOutput","kind":"json-schema","title":"BulkCreateNoteOutput","data":{"title":"BulkCreateNoteOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_ErrorResponse_InternalNoteData"}}}}},"components/schemas/BulkError":{"id":"components/schemas/BulkError","kind":"json-schema","title":"BulkError","data":{"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"}]}},"components/schemas/BulkPatchAgentInput":{"id":"components/schemas/BulkPatchAgentInput","kind":"json-schema","title":"BulkPatchAgentInput","data":{"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"}}}},"components/schemas/BulkPatchEndUserInput":{"id":"components/schemas/BulkPatchEndUserInput","kind":"json-schema","title":"BulkPatchEndUserInput","data":{"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"}}}},"components/schemas/BulkPatchEndUsersInput":{"id":"components/schemas/BulkPatchEndUsersInput","kind":"json-schema","title":"BulkPatchEndUsersInput","data":{"title":"BulkPatchEndUsersInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkPatchEndUserInput"}}}}},"components/schemas/BulkPatchEndUsersOutput":{"id":"components/schemas/BulkPatchEndUsersOutput","kind":"json-schema","title":"BulkPatchEndUsersOutput","data":{"title":"BulkPatchEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_EndUser"}}}}},"components/schemas/BulkQueueEndpointInput":{"id":"components/schemas/BulkQueueEndpointInput","kind":"json-schema","title":"BulkQueueEndpointInput","data":{"title":"BulkQueueEndpointInput","type":"object","properties":{"agentIds":{"type":"array","uniqueItems":true,"items":{"type":"string","format":"uuid"}}}}},"components/schemas/BulkQueueEndpointOutput":{"id":"components/schemas/BulkQueueEndpointOutput","kind":"json-schema","title":"BulkQueueEndpointOutput","data":{"title":"BulkQueueEndpointOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_UUID"}}}}},"components/schemas/BulkTagConversationInput":{"id":"components/schemas/BulkTagConversationInput","kind":"json-schema","title":"BulkTagConversationInput","data":{"title":"BulkTagConversationInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TagConversationInput"}}}}},"components/schemas/BulkUpdateAgentInput":{"id":"components/schemas/BulkUpdateAgentInput","kind":"json-schema","title":"BulkUpdateAgentInput","data":{"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"}}}},"components/schemas/BulkUpdateAgentOutput":{"id":"components/schemas/BulkUpdateAgentOutput","kind":"json-schema","title":"BulkUpdateAgentOutput","data":{"title":"BulkUpdateAgentOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_Agent"}}}}},"components/schemas/BulkUpdateEndUserInput":{"id":"components/schemas/BulkUpdateEndUserInput","kind":"json-schema","title":"BulkUpdateEndUserInput","data":{"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"}}}},"components/schemas/BulkUpdateEndUsersInput":{"id":"components/schemas/BulkUpdateEndUsersInput","kind":"json-schema","title":"BulkUpdateEndUsersInput","data":{"title":"BulkUpdateEndUsersInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateEndUserInput"}}}}},"components/schemas/BulkUpdateEndUsersOutput":{"id":"components/schemas/BulkUpdateEndUsersOutput","kind":"json-schema","title":"BulkUpdateEndUsersOutput","data":{"title":"BulkUpdateEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_EndUser"}}}}},"components/schemas/BusinessHour":{"id":"components/schemas/BusinessHour","kind":"json-schema","title":"BusinessHour","data":{"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"}}}},"components/schemas/BusinessHourException":{"id":"components/schemas/BusinessHourException","kind":"json-schema","title":"BusinessHourException","data":{"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"}}}},"components/schemas/BusinessHourExceptionType":{"id":"components/schemas/BusinessHourExceptionType","kind":"json-schema","title":"BusinessHourExceptionType","data":{"title":"BusinessHourExceptionType","oneOf":[{"$ref":"#/components/schemas/Exception"},{"$ref":"#/components/schemas/Holiday"}]}},"components/schemas/BusinessHourRegular":{"id":"components/schemas/BusinessHourRegular","kind":"json-schema","title":"BusinessHourRegular","data":{"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"}}}},"components/schemas/BusinessHourRegularType":{"id":"components/schemas/BusinessHourRegularType","kind":"json-schema","title":"BusinessHourRegularType","data":{"title":"BusinessHourRegularType","oneOf":[{"$ref":"#/components/schemas/Regular1"}]}},"components/schemas/BusinessHourStatus":{"id":"components/schemas/BusinessHourStatus","kind":"json-schema","title":"BusinessHourStatus","data":{"title":"BusinessHourStatus","oneOf":[{"$ref":"#/components/schemas/Closed"},{"$ref":"#/components/schemas/Open"}]}},"components/schemas/BusinessHourStatus1":{"id":"components/schemas/BusinessHourStatus1","kind":"json-schema","title":"BusinessHourStatus","data":{"title":"BusinessHourStatus","oneOf":[{"$ref":"#/components/schemas/Closed1"},{"$ref":"#/components/schemas/Open1"}]}},"components/schemas/BusinessHourType":{"id":"components/schemas/BusinessHourType","kind":"json-schema","title":"BusinessHourType","data":{"title":"BusinessHourType","oneOf":[{"$ref":"#/components/schemas/Exception1"},{"$ref":"#/components/schemas/Holiday1"},{"$ref":"#/components/schemas/Regular2"}]}},"components/schemas/BusinessHoursSchedule":{"id":"components/schemas/BusinessHoursSchedule","kind":"json-schema","title":"BusinessHoursSchedule","data":{"title":"BusinessHoursSchedule","type":"object","required":["name","id"],"properties":{"name":{"type":"string"},"id":{"type":"string"}}}},"components/schemas/BusinessHoursScheduleDefinition":{"id":"components/schemas/BusinessHoursScheduleDefinition","kind":"json-schema","title":"BusinessHoursScheduleDefinition","data":{"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"}}}}},"components/schemas/BusinessHoursUpcomingSchedule":{"id":"components/schemas/BusinessHoursUpcomingSchedule","kind":"json-schema","title":"BusinessHoursUpcomingSchedule","data":{"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"}}}}},"components/schemas/ByContactPoints":{"id":"components/schemas/ByContactPoints","kind":"json-schema","title":"ByContactPoints","data":{"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"}}}},"components/schemas/ById":{"id":"components/schemas/ById","kind":"json-schema","title":"ById","data":{"title":"ById","type":"object","required":["userId"],"properties":{"userId":{"description":"Dixa end-user ID","type":"string"}}}},"components/schemas/CallRecordingAttributes":{"id":"components/schemas/CallRecordingAttributes","kind":"json-schema","title":"CallRecordingAttributes","data":{"title":"CallRecordingAttributes","type":"object","required":["recording"],"properties":{"duration":{"type":"integer","format":"int32"},"recording":{"type":"string"}}}},"components/schemas/Callback":{"id":"components/schemas/Callback","kind":"json-schema","title":"Callback","data":{"title":"Callback","type":"object","required":["requesterId","direction","contactEndpointId","queueId"],"properties":{"requesterId":{"description":"The end user's userId","type":"string","format":"uuid"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Outbound]"},"children":[]}]}]}],"type":"string"},"contactEndpointId":{"type":"string"},"queueId":{"type":"string","format":"uuid"}}}},"components/schemas/Category":{"id":"components/schemas/Category","kind":"json-schema","title":"Category","data":{"title":"Category","type":"object","required":["id","isLocked","restrictions"],"properties":{"id":{"type":"string"},"title":{"$ref":"#/components/schemas/TranslationTitle"},"isDefaultLocation":{"type":"boolean"},"isLocked":{"type":"boolean"},"restrictions":{"$ref":"#/components/schemas/Restrictions"},"parentCategory":{"type":"string"},"parentCollections":{"type":"array","items":{"type":"string"}}}}},"components/schemas/CategoryCatalogItem":{"id":"components/schemas/CategoryCatalogItem","kind":"json-schema","title":"CategoryCatalogItem","data":{"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"}}}}},"components/schemas/CategoryTranslations":{"id":"components/schemas/CategoryTranslations","kind":"json-schema","title":"CategoryTranslations","data":{"title":"CategoryTranslations","type":"object","properties":{"titles":{"type":"array","items":{"$ref":"#/components/schemas/TranslationTitle"}}}}},"components/schemas/Channel":{"id":"components/schemas/Channel","kind":"json-schema","title":"Channel","data":{"title":"Channel","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/ChannelOperator"}}}},"components/schemas/ChannelAvailability":{"id":"components/schemas/ChannelAvailability","kind":"json-schema","title":"ChannelAvailability","data":{"title":"ChannelAvailability","oneOf":[{"$ref":"#/components/schemas/GenericChannel"}]}},"components/schemas/ChannelAvailabilityError":{"id":"components/schemas/ChannelAvailabilityError","kind":"json-schema","title":"ChannelAvailabilityError","data":{"title":"ChannelAvailabilityError","oneOf":[{"$ref":"#/components/schemas/UnexpectedError"}]}},"components/schemas/ChannelAvailabilityOutcome":{"id":"components/schemas/ChannelAvailabilityOutcome","kind":"json-schema","title":"ChannelAvailabilityOutcome","data":{"title":"ChannelAvailabilityOutcome","oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/Success"}]}},"components/schemas/ChannelOperator":{"id":"components/schemas/ChannelOperator","kind":"json-schema","title":"ChannelOperator","data":{"title":"ChannelOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf1"},{"$ref":"#/components/schemas/IsOneOf1"}]}},"components/schemas/Chat":{"id":"components/schemas/Chat","kind":"json-schema","title":"Chat","data":{"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"}}}},"components/schemas/ChatAttributes":{"id":"components/schemas/ChatAttributes","kind":"json-schema","title":"ChatAttributes","data":{"title":"ChatAttributes","type":"object","required":["isAutomated"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"isAutomated":{"type":"boolean"}}}},"components/schemas/ChatConversation":{"id":"components/schemas/ChatConversation","kind":"json-schema","title":"ChatConversation","data":{"title":"ChatConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/Checksum":{"id":"components/schemas/Checksum","kind":"json-schema","title":"Checksum","data":{"title":"Checksum","type":"object","required":["algorithm","hex"],"properties":{"algorithm":{"type":"string"},"hex":{"type":"string"}}}},"components/schemas/ClaimConversationInput":{"id":"components/schemas/ClaimConversationInput","kind":"json-schema","title":"ClaimConversationInput","data":{"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"}}}},"components/schemas/CloseConversationInput":{"id":"components/schemas/CloseConversationInput","kind":"json-schema","title":"CloseConversationInput","data":{"title":"CloseConversationInput","type":"object","properties":{"userId":{"type":"string","format":"uuid"}}}},"components/schemas/Closed":{"id":"components/schemas/Closed","kind":"json-schema","title":"Closed","data":{"title":"Closed","type":"object"}},"components/schemas/Closed1":{"id":"components/schemas/Closed1","kind":"json-schema","title":"Closed","data":{"title":"Closed","type":"object"}},"components/schemas/ClosedDate":{"id":"components/schemas/ClosedDate","kind":"json-schema","title":"ClosedDate","data":{"title":"ClosedDate","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}}},"components/schemas/Closing":{"id":"components/schemas/Closing","kind":"json-schema","title":"Closing","data":{"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"}}}},"components/schemas/Collection":{"id":"components/schemas/Collection","kind":"json-schema","title":"Collection","data":{"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"}}}},"components/schemas/CollectionCatalogItem":{"id":"components/schemas/CollectionCatalogItem","kind":"json-schema","title":"CollectionCatalogItem","data":{"title":"CollectionCatalogItem","type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryCatalogItem"}},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleCatalogItem"}}}}},"components/schemas/CombinedFilters":{"id":"components/schemas/CombinedFilters","kind":"json-schema","title":"CombinedFilters","data":{"title":"CombinedFilters","type":"object","required":["strategy","conditions"],"properties":{"strategy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [All, Any]"},"children":[]}]}]}],"type":"string"},"conditions":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Condition1"}}}}},"components/schemas/CommerceEvent":{"id":"components/schemas/CommerceEvent","kind":"json-schema","title":"CommerceEvent","data":{"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"}}}},"components/schemas/CommerceEventPayload":{"id":"components/schemas/CommerceEventPayload","kind":"json-schema","title":"CommerceEventPayload","data":{"title":"CommerceEventPayload","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Typed event payload. The _type field determines the event variant."},"children":[]}]}]}],"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"}]}},"components/schemas/Condition":{"id":"components/schemas/Condition","kind":"json-schema","title":"Condition","data":{"title":"Condition","type":"object","required":["field"],"properties":{"field":{"$ref":"#/components/schemas/SearchField"}}}},"components/schemas/Condition1":{"id":"components/schemas/Condition1","kind":"json-schema","title":"Condition","data":{"title":"Condition","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf5"},{"$ref":"#/components/schemas/IsOneOf5"}]}},"components/schemas/Conflict":{"id":"components/schemas/Conflict","kind":"json-schema","title":"Conflict","data":{"title":"Conflict","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/ContactEndpoint":{"id":"components/schemas/ContactEndpoint","kind":"json-schema","title":"ContactEndpoint","data":{"title":"ContactEndpoint","oneOf":[{"$ref":"#/components/schemas/EmailEndpoint"},{"$ref":"#/components/schemas/TelephonyEndpoint"}]}},"components/schemas/ContactForm":{"id":"components/schemas/ContactForm","kind":"json-schema","title":"ContactForm","data":{"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"}}}},"components/schemas/ContactFormAttributes":{"id":"components/schemas/ContactFormAttributes","kind":"json-schema","title":"ContactFormAttributes","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files the sender embedded in the message body, such as the images that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailContent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references. The sending email client decides whether a file is embedded or attached, so a file you would expect in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can arrive here instead. Read both fields to get every file on the message."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/File"}},"attachments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files the sender attached to the message. Files the sender embedded in the message body are listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineImages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/File"}},"deliveryFailureReason":{"type":"string"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"originalContentUrl":{"$ref":"#/components/schemas/File"}}}},"components/schemas/ContactFormConversation":{"id":"components/schemas/ContactFormConversation","kind":"json-schema","title":"ContactFormConversation","data":{"title":"ContactFormConversation","type":"object","required":["id","requesterId","channel","createdAt","fromEmail"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/ContactId":{"id":"components/schemas/ContactId","kind":"json-schema","title":"ContactId","data":{"title":"ContactId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldHasSingleValueOperator"}}}},"components/schemas/ContactPoint":{"id":"components/schemas/ContactPoint","kind":"json-schema","title":"ContactPoint","data":{"title":"ContactPoint","oneOf":[{"$ref":"#/components/schemas/Email1"},{"$ref":"#/components/schemas/Phone"}]}},"components/schemas/Content":{"id":"components/schemas/Content","kind":"json-schema","title":"Content","data":{"title":"Content","oneOf":[{"$ref":"#/components/schemas/Html"},{"$ref":"#/components/schemas/Markdown"},{"$ref":"#/components/schemas/Text"}]}},"components/schemas/Conversation":{"id":"components/schemas/Conversation","kind":"json-schema","title":"Conversation","data":{"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"}]}},"components/schemas/ConversationAnonymizationType":{"id":"components/schemas/ConversationAnonymizationType","kind":"json-schema","title":"ConversationAnonymizationType","data":{"title":"ConversationAnonymizationType","type":"object"}},"components/schemas/ConversationAssignedActivityType":{"id":"components/schemas/ConversationAssignedActivityType","kind":"json-schema","title":"ConversationAssignedActivityType","data":{"title":"ConversationAssignedActivityType","type":"object"}},"components/schemas/ConversationAssignedAttribute":{"id":"components/schemas/ConversationAssignedAttribute","kind":"json-schema","title":"ConversationAssignedAttribute","data":{"title":"ConversationAssignedAttribute","type":"object","required":["agentId"],"properties":{"agentId":{"type":"string"},"agentName":{"type":"string"}}}},"components/schemas/ConversationAutoReplySentAttribute":{"id":"components/schemas/ConversationAutoReplySentAttribute","kind":"json-schema","title":"ConversationAutoReplySentAttribute","data":{"title":"ConversationAutoReplySentAttribute","type":"object","required":["templateName"],"properties":{"templateName":{"type":"string"}}}},"components/schemas/ConversationAutoreplySentActivityType":{"id":"components/schemas/ConversationAutoreplySentActivityType","kind":"json-schema","title":"ConversationAutoreplySentActivityType","data":{"title":"ConversationAutoreplySentActivityType","type":"object"}},"components/schemas/ConversationChannelChangedAttribute":{"id":"components/schemas/ConversationChannelChangedAttribute","kind":"json-schema","title":"ConversationChannelChangedAttribute","data":{"title":"ConversationChannelChangedAttribute","type":"object","required":["channelReference"],"properties":{"channelReference":{"type":"string"}}}},"components/schemas/ConversationClaimedActivityType":{"id":"components/schemas/ConversationClaimedActivityType","kind":"json-schema","title":"ConversationClaimedActivityType","data":{"title":"ConversationClaimedActivityType","type":"object"}},"components/schemas/ConversationClaimedAttribute":{"id":"components/schemas/ConversationClaimedAttribute","kind":"json-schema","title":"ConversationClaimedAttribute","data":{"title":"ConversationClaimedAttribute","type":"object","properties":{"claimedFromLabel":{"type":"string"},"claimedFromType":{"type":"string"}}}},"components/schemas/ConversationClosedActivityType":{"id":"components/schemas/ConversationClosedActivityType","kind":"json-schema","title":"ConversationClosedActivityType","data":{"title":"ConversationClosedActivityType","type":"object"}},"components/schemas/ConversationCreatedAttribute":{"id":"components/schemas/ConversationCreatedAttribute","kind":"json-schema","title":"ConversationCreatedAttribute","data":{"title":"ConversationCreatedAttribute","type":"object","properties":{"subject":{"type":"string"}}}},"components/schemas/ConversationCreatedByAgentActivityType":{"id":"components/schemas/ConversationCreatedByAgentActivityType","kind":"json-schema","title":"ConversationCreatedByAgentActivityType","data":{"title":"ConversationCreatedByAgentActivityType","type":"object"}},"components/schemas/ConversationCreatedByCustomerActivityType":{"id":"components/schemas/ConversationCreatedByCustomerActivityType","kind":"json-schema","title":"ConversationCreatedByCustomerActivityType","data":{"title":"ConversationCreatedByCustomerActivityType","type":"object"}},"components/schemas/ConversationCustomAttributesUpdatedAttribute":{"id":"components/schemas/ConversationCustomAttributesUpdatedAttribute","kind":"json-schema","title":"ConversationCustomAttributesUpdatedAttribute","data":{"title":"ConversationCustomAttributesUpdatedAttribute","type":"object","required":["updatedAttributeValues"],"properties":{"updatedAttributeIds":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"updatedAttributeValues":{"$ref":"#/components/schemas/Map_AttributeValue"}}}},"components/schemas/ConversationEndUserReplacedActivityType":{"id":"components/schemas/ConversationEndUserReplacedActivityType","kind":"json-schema","title":"ConversationEndUserReplacedActivityType","data":{"title":"ConversationEndUserReplacedActivityType","type":"object"}},"components/schemas/ConversationEndUserReplacedAttribute":{"id":"components/schemas/ConversationEndUserReplacedAttribute","kind":"json-schema","title":"ConversationEndUserReplacedAttribute","data":{"title":"ConversationEndUserReplacedAttribute","type":"object","required":["oldUser","newUser"],"properties":{"oldUser":{"$ref":"#/components/schemas/ActivityLogUser"},"newUser":{"$ref":"#/components/schemas/ActivityLogUser"}}}},"components/schemas/ConversationFlow":{"id":"components/schemas/ConversationFlow","kind":"json-schema","title":"ConversationFlow","data":{"title":"ConversationFlow","type":"object","required":["id","name","channel","contactEndpointId"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"contactEndpointId":{"type":"string"}}}},"components/schemas/ConversationId":{"id":"components/schemas/ConversationId","kind":"json-schema","title":"ConversationId","data":{"title":"ConversationId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldHasSingleValueOperator"}}}},"components/schemas/ConversationLanguageUpdatedActivityType":{"id":"components/schemas/ConversationLanguageUpdatedActivityType","kind":"json-schema","title":"ConversationLanguageUpdatedActivityType","data":{"title":"ConversationLanguageUpdatedActivityType","type":"object"}},"components/schemas/ConversationLanguageUpdatedAttribute":{"id":"components/schemas/ConversationLanguageUpdatedAttribute","kind":"json-schema","title":"ConversationLanguageUpdatedAttribute","data":{"title":"ConversationLanguageUpdatedAttribute","type":"object","required":["language"],"properties":{"language":{"type":"string"}}}},"components/schemas/ConversationLink":{"id":"components/schemas/ConversationLink","kind":"json-schema","title":"ConversationLink","data":{"title":"ConversationLink","oneOf":[{"$ref":"#/components/schemas/EmailForward"},{"$ref":"#/components/schemas/FollowUp"},{"$ref":"#/components/schemas/SideConversation"}]}},"components/schemas/ConversationLinkedAttribute":{"id":"components/schemas/ConversationLinkedAttribute","kind":"json-schema","title":"ConversationLinkedAttribute","data":{"title":"ConversationLinkedAttribute","type":"object","required":["child","parent","linkType"],"properties":{"child":{"type":"integer","format":"int64"},"parent":{"type":"integer","format":"int64"},"linkType":{"type":"string"}}}},"components/schemas/ConversationOfferAcceptedActivityType":{"id":"components/schemas/ConversationOfferAcceptedActivityType","kind":"json-schema","title":"ConversationOfferAcceptedActivityType","data":{"title":"ConversationOfferAcceptedActivityType","type":"object"}},"components/schemas/ConversationOfferRejectedActivityType":{"id":"components/schemas/ConversationOfferRejectedActivityType","kind":"json-schema","title":"ConversationOfferRejectedActivityType","data":{"title":"ConversationOfferRejectedActivityType","type":"object"}},"components/schemas/ConversationOfferTimeoutActivityType":{"id":"components/schemas/ConversationOfferTimeoutActivityType","kind":"json-schema","title":"ConversationOfferTimeoutActivityType","data":{"title":"ConversationOfferTimeoutActivityType","type":"object"}},"components/schemas/ConversationOfferedActivityType":{"id":"components/schemas/ConversationOfferedActivityType","kind":"json-schema","title":"ConversationOfferedActivityType","data":{"title":"ConversationOfferedActivityType","type":"object"}},"components/schemas/ConversationOfferedAttribute":{"id":"components/schemas/ConversationOfferedAttribute","kind":"json-schema","title":"ConversationOfferedAttribute","data":{"title":"ConversationOfferedAttribute","type":"object","properties":{"agentNames":{"type":"array","items":{"type":"string"}},"queueLabel":{"type":"string"}}}},"components/schemas/ConversationPendingActivityType":{"id":"components/schemas/ConversationPendingActivityType","kind":"json-schema","title":"ConversationPendingActivityType","data":{"title":"ConversationPendingActivityType","type":"object"}},"components/schemas/ConversationRatedActivityType":{"id":"components/schemas/ConversationRatedActivityType","kind":"json-schema","title":"ConversationRatedActivityType","data":{"title":"ConversationRatedActivityType","type":"object"}},"components/schemas/ConversationRatedAttribute":{"id":"components/schemas/ConversationRatedAttribute","kind":"json-schema","title":"ConversationRatedAttribute","data":{"title":"ConversationRatedAttribute","type":"object","properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"},"score":{"type":"integer","format":"int32"},"message":{"type":"string"}}}},"components/schemas/ConversationRating":{"id":"components/schemas/ConversationRating","kind":"json-schema","title":"ConversationRating","data":{"title":"ConversationRating","type":"object","required":["id","ratingType","conversationChannel","userId","ratingStatus","timestamps"],"properties":{"id":{"type":"string"},"ratingScore":{"type":"integer","format":"int32"},"ratingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Csat, Nps, ThumbsUpOrDown]"},"children":[]}]}]}],"type":"string"},"ratingComment":{"type":"string"},"conversationChannel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"agentId":{"type":"string"},"userId":{"type":"string"},"ratingStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Unscheduled, Offered, Rated, Scheduled, Cancelled]"},"children":[]}]}]}],"type":"string"},"language":{"type":"string"},"timestamps":{"$ref":"#/components/schemas/Map_String"}}}},"components/schemas/ConversationRatingCancelledActivityType":{"id":"components/schemas/ConversationRatingCancelledActivityType","kind":"json-schema","title":"ConversationRatingCancelledActivityType","data":{"title":"ConversationRatingCancelledActivityType","type":"object"}},"components/schemas/ConversationRatingNotOfferedAttribute":{"id":"components/schemas/ConversationRatingNotOfferedAttribute","kind":"json-schema","title":"ConversationRatingNotOfferedAttribute","data":{"title":"ConversationRatingNotOfferedAttribute","type":"object","properties":{"evaluationFilters":{"type":"string"}}}},"components/schemas/ConversationRatingOfferedActivityType":{"id":"components/schemas/ConversationRatingOfferedActivityType","kind":"json-schema","title":"ConversationRatingOfferedActivityType","data":{"title":"ConversationRatingOfferedActivityType","type":"object"}},"components/schemas/ConversationRatingOfferedAttribute":{"id":"components/schemas/ConversationRatingOfferedAttribute","kind":"json-schema","title":"ConversationRatingOfferedAttribute","data":{"title":"ConversationRatingOfferedAttribute","type":"object","required":["agent","user"],"properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"},"user":{"$ref":"#/components/schemas/ActivityLogUser"}}}},"components/schemas/ConversationRatingScheduledActivityType":{"id":"components/schemas/ConversationRatingScheduledActivityType","kind":"json-schema","title":"ConversationRatingScheduledActivityType","data":{"title":"ConversationRatingScheduledActivityType","type":"object"}},"components/schemas/ConversationRatingScheduledAttribute":{"id":"components/schemas/ConversationRatingScheduledAttribute","kind":"json-schema","title":"ConversationRatingScheduledAttribute","data":{"title":"ConversationRatingScheduledAttribute","type":"object","required":["ratingScheduledTime"],"properties":{"ratingScheduledTime":{"type":"string"}}}},"components/schemas/ConversationRatingUnscheduledActivityType":{"id":"components/schemas/ConversationRatingUnscheduledActivityType","kind":"json-schema","title":"ConversationRatingUnscheduledActivityType","data":{"title":"ConversationRatingUnscheduledActivityType","type":"object"}},"components/schemas/ConversationReopenedActivityType":{"id":"components/schemas/ConversationReopenedActivityType","kind":"json-schema","title":"ConversationReopenedActivityType","data":{"title":"ConversationReopenedActivityType","type":"object"}},"components/schemas/ConversationReservedAttribute":{"id":"components/schemas/ConversationReservedAttribute","kind":"json-schema","title":"ConversationReservedAttribute","data":{"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"}}}},"components/schemas/ConversationReservedType":{"id":"components/schemas/ConversationReservedType","kind":"json-schema","title":"ConversationReservedType","data":{"title":"ConversationReservedType","type":"object"}},"components/schemas/ConversationResolvedStateToggledAttribute":{"id":"components/schemas/ConversationResolvedStateToggledAttribute","kind":"json-schema","title":"ConversationResolvedStateToggledAttribute","data":{"title":"ConversationResolvedStateToggledAttribute","type":"object","required":["isResolved"],"properties":{"isResolved":{"type":"boolean"}}}},"components/schemas/ConversationResponse":{"id":"components/schemas/ConversationResponse","kind":"json-schema","title":"ConversationResponse","data":{"title":"ConversationResponse","type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64"}}}},"components/schemas/ConversationSearchHit":{"id":"components/schemas/ConversationSearchHit","kind":"json-schema","title":"ConversationSearchHit","data":{"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"}}}}},"components/schemas/ConversationSearchInnerHit":{"id":"components/schemas/ConversationSearchInnerHit","kind":"json-schema","title":"ConversationSearchInnerHit","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snippet of text where a match was found. Matched text will be wrapped in <em> tags"},"children":[]}]}]}]}}}},"components/schemas/ConversationSearchWithFiltersHit":{"id":"components/schemas/ConversationSearchWithFiltersHit","kind":"json-schema","title":"ConversationSearchWithFiltersHit","data":{"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"}}}},"components/schemas/ConversationSubjectUpdatedAttribute":{"id":"components/schemas/ConversationSubjectUpdatedAttribute","kind":"json-schema","title":"ConversationSubjectUpdatedAttribute","data":{"title":"ConversationSubjectUpdatedAttribute","type":"object","required":["oldSubject","newSubject"],"properties":{"oldSubject":{"type":"string"},"newSubject":{"type":"string"}}}},"components/schemas/ConversationTagsOutput":{"id":"components/schemas/ConversationTagsOutput","kind":"json-schema","title":"ConversationTagsOutput","data":{"title":"ConversationTagsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"components/schemas/ConversationTranscriptionEndedActivityType":{"id":"components/schemas/ConversationTranscriptionEndedActivityType","kind":"json-schema","title":"ConversationTranscriptionEndedActivityType","data":{"title":"ConversationTranscriptionEndedActivityType","type":"object"}},"components/schemas/ConversationTranscriptionEndedAttribute":{"id":"components/schemas/ConversationTranscriptionEndedAttribute","kind":"json-schema","title":"ConversationTranscriptionEndedAttribute","data":{"title":"ConversationTranscriptionEndedAttribute","type":"object","required":["isSuccessful"],"properties":{"isSuccessful":{"type":"boolean"},"failureReason":{"type":"string"}}}},"components/schemas/ConversationTranscriptionStartedActivityType":{"id":"components/schemas/ConversationTranscriptionStartedActivityType","kind":"json-schema","title":"ConversationTranscriptionStartedActivityType","data":{"title":"ConversationTranscriptionStartedActivityType","type":"object"}},"components/schemas/ConversationTransferredAttribute":{"id":"components/schemas/ConversationTransferredAttribute","kind":"json-schema","title":"ConversationTransferredAttribute","data":{"title":"ConversationTransferredAttribute","type":"object","required":["transferType","destinationType","destinationId"],"properties":{"transferType":{"type":"string"},"destinationType":{"type":"string"},"destinationId":{"type":"string"},"destinationLabel":{"type":"string"},"reason":{"type":"string"}}}},"components/schemas/ConversationUnassignedActivityType":{"id":"components/schemas/ConversationUnassignedActivityType","kind":"json-schema","title":"ConversationUnassignedActivityType","data":{"title":"ConversationUnassignedActivityType","type":"object"}},"components/schemas/ConversationUnassignedAttribute":{"id":"components/schemas/ConversationUnassignedAttribute","kind":"json-schema","title":"ConversationUnassignedAttribute","data":{"title":"ConversationUnassignedAttribute","type":"object","required":["agent"],"properties":{"agent":{"$ref":"#/components/schemas/ActivityLogUser"}}}},"components/schemas/CreateAgentInput":{"id":"components/schemas/CreateAgentInput","kind":"json-schema","title":"CreateAgentInput","data":{"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"}}}},"components/schemas/CreateAgentsInput":{"id":"components/schemas/CreateAgentsInput","kind":"json-schema","title":"CreateAgentsInput","data":{"title":"CreateAgentsInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateAgentInput"}}}}},"components/schemas/CreateAgentsOutput":{"id":"components/schemas/CreateAgentsOutput","kind":"json-schema","title":"CreateAgentsOutput","data":{"title":"CreateAgentsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_Agent"}}}}},"components/schemas/CreateConversationInput":{"id":"components/schemas/CreateConversationInput","kind":"json-schema","title":"CreateConversationInput","data":{"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"}]}},"components/schemas/CreateConversationOutput":{"id":"components/schemas/CreateConversationOutput","kind":"json-schema","title":"CreateConversationOutput","data":{"title":"CreateConversationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ConversationResponse"}}}},"components/schemas/CreateEndUserInput":{"id":"components/schemas/CreateEndUserInput","kind":"json-schema","title":"CreateEndUserInput","data":{"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"}}}},"components/schemas/CreateEndUserOutput":{"id":"components/schemas/CreateEndUserOutput","kind":"json-schema","title":"CreateEndUserOutput","data":{"title":"CreateEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}}},"components/schemas/CreateEndUsersInput":{"id":"components/schemas/CreateEndUsersInput","kind":"json-schema","title":"CreateEndUsersInput","data":{"title":"CreateEndUsersInput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreateEndUserInput"}}}}},"components/schemas/CreateEndUsersOutput":{"id":"components/schemas/CreateEndUsersOutput","kind":"json-schema","title":"CreateEndUsersOutput","data":{"title":"CreateEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionOutcome_BulkError_EndUser"}}}}},"components/schemas/CreateInternalNoteInput":{"id":"components/schemas/CreateInternalNoteInput","kind":"json-schema","title":"CreateInternalNoteInput","data":{"title":"CreateInternalNoteInput","type":"object","required":["message"],"properties":{"message":{"type":"string"},"agentId":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"}}}},"components/schemas/CreateKnowledgeArticleInput":{"id":"components/schemas/CreateKnowledgeArticleInput","kind":"json-schema","title":"CreateKnowledgeArticleInput","data":{"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"}}}},"components/schemas/CreateKnowledgeArticleOutput":{"id":"components/schemas/CreateKnowledgeArticleOutput","kind":"json-schema","title":"CreateKnowledgeArticleOutput","data":{"title":"CreateKnowledgeArticleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Article","description":"The created article"}}}},"components/schemas/CreateMessageInput":{"id":"components/schemas/CreateMessageInput","kind":"json-schema","title":"CreateMessageInput","data":{"title":"CreateMessageInput","description":"Only Outbound messages are supported for Sms and Whatsapp.","oneOf":[{"$ref":"#/components/schemas/Inbound"},{"$ref":"#/components/schemas/Outbound"}]}},"components/schemas/CreateMessageOutput":{"id":"components/schemas/CreateMessageOutput","kind":"json-schema","title":"CreateMessageOutput","data":{"title":"CreateMessageOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CreateMessageOutputData"}}}},"components/schemas/CreateMessageOutputData":{"id":"components/schemas/CreateMessageOutputData","kind":"json-schema","title":"CreateMessageOutputData","data":{"title":"CreateMessageOutputData","type":"object","required":["direction","authorId"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"authorId":{"type":"string","format":"uuid"},"externalId":{"type":"string"},"messageId":{"type":"string","format":"uuid"},"createdAt":{"type":"string"}}}},"components/schemas/CreateNoteOutput":{"id":"components/schemas/CreateNoteOutput","kind":"json-schema","title":"CreateNoteOutput","data":{"title":"CreateNoteOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InternalNoteData"}}}},"components/schemas/CreateOrUpdateQueueRequest":{"id":"components/schemas/CreateOrUpdateQueueRequest","kind":"json-schema","title":"CreateOrUpdateQueueRequest","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]"},"children":[]}]}]}],"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"}}}},"components/schemas/CreateQueueInput":{"id":"components/schemas/CreateQueueInput","kind":"json-schema","title":"CreateQueueInput","data":{"title":"CreateQueueInput","type":"object","required":["request"],"properties":{"request":{"$ref":"#/components/schemas/CreateOrUpdateQueueRequest"}}}},"components/schemas/CreateQueueOutput":{"id":"components/schemas/CreateQueueOutput","kind":"json-schema","title":"CreateQueueOutput","data":{"title":"CreateQueueOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Queue1"}}}},"components/schemas/CreateRatingOfferInput":{"id":"components/schemas/CreateRatingOfferInput","kind":"json-schema","title":"CreateRatingOfferInput","data":{"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"}}}},"components/schemas/CreateRatingOfferOutput":{"id":"components/schemas/CreateRatingOfferOutput","kind":"json-schema","title":"CreateRatingOfferOutput","data":{"title":"CreateRatingOfferOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RatingOffer"}}}},"components/schemas/CreateRatingResultInput":{"id":"components/schemas/CreateRatingResultInput","kind":"json-schema","title":"CreateRatingResultInput","data":{"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"}}}},"components/schemas/CreateRatingResultOutput":{"id":"components/schemas/CreateRatingResultOutput","kind":"json-schema","title":"CreateRatingResultOutput","data":{"title":"CreateRatingResultOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/RatingResult"}}}},"components/schemas/CreateTagInput":{"id":"components/schemas/CreateTagInput","kind":"json-schema","title":"CreateTagInput","data":{"title":"CreateTagInput","type":"object","required":["name"],"properties":{"name":{"type":"string"},"color":{"type":"string"}}}},"components/schemas/CreateTagOutput":{"id":"components/schemas/CreateTagOutput","kind":"json-schema","title":"CreateTagOutput","data":{"title":"CreateTagOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Tag"}}}},"components/schemas/CreateTeamInput":{"id":"components/schemas/CreateTeamInput","kind":"json-schema","title":"CreateTeamInput","data":{"title":"CreateTeamInput","type":"object","required":["name"],"properties":{"name":{"type":"string"}}}},"components/schemas/CreateTeamOutput":{"id":"components/schemas/CreateTeamOutput","kind":"json-schema","title":"CreateTeamOutput","data":{"title":"CreateTeamOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Team1"}}}},"components/schemas/CreateTemplateInput":{"id":"components/schemas/CreateTemplateInput","kind":"json-schema","title":"CreateTemplateInput","data":{"title":"CreateTemplateInput","type":"object","required":["name","language","templateType","category","variables"],"properties":{"name":{"description":"Template name; may only contain lowercase letters, digits, and underscores","type":"string"},"language":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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"},"children":[]}]}]}],"type":"string"},"templateType":{"$ref":"#/components/schemas/TemplateTypeInput"},"category":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [UTILITY, MARKETING]"},"children":[]}]}]}],"type":"string"},"variables":{"$ref":"#/components/schemas/Map_String","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sample values for the template's placeholders (e.g. {\"1\": \"John\"}), submitted to WhatsApp as example content during template approval"},"children":[]}]}]}]}}}},"components/schemas/CreateTemplateOutput":{"id":"components/schemas/CreateTemplateOutput","kind":"json-schema","title":"CreateTemplateOutput","data":{"title":"CreateTemplateOutput","type":"object","required":["id"],"properties":{"id":{"type":"string"}}}},"components/schemas/CreateWebhookSubscriptionInput":{"id":"components/schemas/CreateWebhookSubscriptionInput","kind":"json-schema","title":"CreateWebhookSubscriptionInput","data":{"title":"CreateWebhookSubscriptionInput","type":"object","required":["name","url","authorization","customHeaders"],"properties":{"name":{"description":"The Webhook Subscription name","type":"string"},"events":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"type":"array","uniqueItems":true,"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines whether this Webhook Subscription is enabled or disabled. Default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]}],"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..."}}}},"components/schemas/CreateWebhookSubscriptionOutput":{"id":"components/schemas/CreateWebhookSubscriptionOutput","kind":"json-schema","title":"CreateWebhookSubscriptionOutput","data":{"title":"CreateWebhookSubscriptionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"components/schemas/CreateWhatsappTemplateOutput":{"id":"components/schemas/CreateWhatsappTemplateOutput","kind":"json-schema","title":"CreateWhatsappTemplateOutput","data":{"title":"CreateWhatsappTemplateOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CreateTemplateOutput"}}}},"components/schemas/CreationDate":{"id":"components/schemas/CreationDate","kind":"json-schema","title":"CreationDate","data":{"title":"CreationDate","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}}},"components/schemas/Csat":{"id":"components/schemas/Csat","kind":"json-schema","title":"Csat","data":{"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"}}}},"components/schemas/CustomAttribute":{"id":"components/schemas/CustomAttribute","kind":"json-schema","title":"CustomAttribute","data":{"title":"CustomAttribute","type":"object","required":["id","name","identifier","value"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"identifier":{"type":"string"},"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text"},"children":[]}]}]}],"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}}},"components/schemas/CustomAttribute1":{"id":"components/schemas/CustomAttribute1","kind":"json-schema","title":"CustomAttribute","data":{"title":"CustomAttribute","type":"object","required":["operator","attributeId"],"properties":{"operator":{"$ref":"#/components/schemas/CustomAttributeOperator"},"attributeId":{"type":"string"}}}},"components/schemas/CustomAttributeDefinition":{"id":"components/schemas/CustomAttributeDefinition","kind":"json-schema","title":"CustomAttributeDefinition","data":{"title":"CustomAttributeDefinition","type":"object","required":["id","entityType","identifier","label","inputDefinition","createdAt","isRequired","isArchived","isDeactivated"],"properties":{"id":{"type":"string","format":"uuid"},"entityType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Contact, Conversation]"},"children":[]}]}]}],"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"}}}},"components/schemas/CustomAttributeInputDefinition":{"id":"components/schemas/CustomAttributeInputDefinition","kind":"json-schema","title":"CustomAttributeInputDefinition","data":{"title":"CustomAttributeInputDefinition","oneOf":[{"$ref":"#/components/schemas/Select1"},{"$ref":"#/components/schemas/Text2"}]}},"components/schemas/CustomAttributeOperator":{"id":"components/schemas/CustomAttributeOperator","kind":"json-schema","title":"CustomAttributeOperator","data":{"title":"CustomAttributeOperator","oneOf":[{"$ref":"#/components/schemas/IsEmpty"},{"$ref":"#/components/schemas/IsNotEmpty"},{"$ref":"#/components/schemas/IsNotOneOf2"},{"$ref":"#/components/schemas/IsOneOf2"}]}},"components/schemas/DeleteAgentsFromTeamInput":{"id":"components/schemas/DeleteAgentsFromTeamInput","kind":"json-schema","title":"DeleteAgentsFromTeamInput","data":{"title":"DeleteAgentsFromTeamInput","type":"object","properties":{"agentIds":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/DeliveryAttemptFailed":{"id":"components/schemas/DeliveryAttemptFailed","kind":"json-schema","title":"DeliveryAttemptFailed","data":{"title":"DeliveryAttemptFailed","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"fulfillmentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External fulfillment ID — links back to the fulfillment"},"children":[]}]}]}],"type":"string"},"reason":{"description":"Reason for the failed attempt (e.g. no one home, wrong address)","type":"string"}}}},"components/schemas/DeliveryDetail":{"id":"components/schemas/DeliveryDetail","kind":"json-schema","title":"DeliveryDetail","data":{"title":"DeliveryDetail","type":"object","required":["deliveryTimestamp","success","responseCode","responseText"],"properties":{"deliveryTimestamp":{"type":"string"},"success":{"type":"boolean"},"responseCode":{"type":"integer","format":"int32"},"responseText":{"type":"string"}}}},"components/schemas/DeliveryStatus":{"id":"components/schemas/DeliveryStatus","kind":"json-schema","title":"DeliveryStatus","data":{"title":"DeliveryStatus","oneOf":[{"$ref":"#/components/schemas/DeliveryDetail"},{"$ref":"#/components/schemas/NoRecentDelivery"}]}},"components/schemas/DeprecatedActivityLogType":{"id":"components/schemas/DeprecatedActivityLogType","kind":"json-schema","title":"DeprecatedActivityLogType","data":{"title":"DeprecatedActivityLogType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaced by _type field"},"children":[]}]}]}],"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"}]}},"components/schemas/DeprecatedAnonymizationType":{"id":"components/schemas/DeprecatedAnonymizationType","kind":"json-schema","title":"DeprecatedAnonymizationType","data":{"title":"DeprecatedAnonymizationType","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaced by _type field"},"children":[]}]}]}],"deprecated":true,"oneOf":[{"$ref":"#/components/schemas/ConversationAnonymizationType"},{"$ref":"#/components/schemas/MessageAnonymizationType"},{"$ref":"#/components/schemas/UnknownAnonymizationType"},{"$ref":"#/components/schemas/UserAnonymizationType"}]}},"components/schemas/Digitalgenius":{"id":"components/schemas/Digitalgenius","kind":"json-schema","title":"Digitalgenius","data":{"title":"Digitalgenius","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Dixa user associated with the AI agent, used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a message"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/Direction":{"id":"components/schemas/Direction","kind":"json-schema","title":"Direction","data":{"title":"Direction","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/DirectionOperator"}}}},"components/schemas/DirectionOperator":{"id":"components/schemas/DirectionOperator","kind":"json-schema","title":"DirectionOperator","data":{"title":"DirectionOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf3"},{"$ref":"#/components/schemas/IsOneOf3"}]}},"components/schemas/DoubleAggregateValue":{"id":"components/schemas/DoubleAggregateValue","kind":"json-schema","title":"DoubleAggregateValue","data":{"title":"DoubleAggregateValue","type":"object","required":["value","measure"],"properties":{"value":{"type":"number","format":"double"},"measure":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Min, Max, Sum, Percentage, AgentPresenceDuration, StdDev, Average]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/DoubleField":{"id":"components/schemas/DoubleField","kind":"json-schema","title":"DoubleField","data":{"title":"DoubleField","type":"object","required":["value"],"properties":{"value":{"type":"number","format":"double"}}}},"components/schemas/Duration":{"id":"components/schemas/Duration","kind":"json-schema","title":"Duration","data":{"title":"Duration","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/DurationOperator"}}}},"components/schemas/DurationOperator":{"id":"components/schemas/DurationOperator","kind":"json-schema","title":"DurationOperator","data":{"title":"DurationOperator","oneOf":[{"$ref":"#/components/schemas/Between1"},{"$ref":"#/components/schemas/LongerThanOrEqualTo"},{"$ref":"#/components/schemas/ShorterThanOrEqualTo"}]}},"components/schemas/Email":{"id":"components/schemas/Email","kind":"json-schema","title":"Email","data":{"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"}}}},"components/schemas/Email1":{"id":"components/schemas/Email1","kind":"json-schema","title":"Email","data":{"title":"Email","type":"object","required":["value"],"properties":{"value":{"description":"Email address","type":"string"}}}},"components/schemas/EmailAttributes":{"id":"components/schemas/EmailAttributes","kind":"json-schema","title":"EmailAttributes","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files the sender embedded in the message body, such as the images that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emailContent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references. The sending email client decides whether a file is embedded or attached, so a file you would expect in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can arrive here instead. Read both fields to get every file on the message."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/File"}},"attachments":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files the sender attached to the message. Files the sender embedded in the message body are listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inlineImages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/File"}},"deliveryFailureReason":{"type":"string"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"originalContentUrl":{"$ref":"#/components/schemas/File"}}}},"components/schemas/EmailAutoReply":{"id":"components/schemas/EmailAutoReply","kind":"json-schema","title":"EmailAutoReply","data":{"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"}}}},"components/schemas/EmailContact":{"id":"components/schemas/EmailContact","kind":"json-schema","title":"EmailContact","data":{"title":"EmailContact","type":"object","required":["email"],"properties":{"email":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/EmailContent":{"id":"components/schemas/EmailContent","kind":"json-schema","title":"EmailContent","data":{"title":"EmailContent","oneOf":[{"$ref":"#/components/schemas/Regular"},{"$ref":"#/components/schemas/TooLarge"}]}},"components/schemas/EmailConversation":{"id":"components/schemas/EmailConversation","kind":"json-schema","title":"EmailConversation","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/EmailEndpoint":{"id":"components/schemas/EmailEndpoint","kind":"json-schema","title":"EmailEndpoint","data":{"title":"EmailEndpoint","type":"object","required":["address"],"properties":{"address":{"type":"string"},"senderOverride":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/EmailForward":{"id":"components/schemas/EmailForward","kind":"json-schema","title":"EmailForward","data":{"title":"EmailForward","type":"object","required":["parentId"],"properties":{"parentId":{"type":"integer","format":"int64"}}}},"components/schemas/EmptyPatchSet":{"id":"components/schemas/EmptyPatchSet","kind":"json-schema","title":"EmptyPatchSet","data":{"title":"EmptyPatchSet","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/EndUser":{"id":"components/schemas/EndUser","kind":"json-schema","title":"EndUser","data":{"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"}}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"title":"ErrorResponse","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/EventDeliveryLog":{"id":"components/schemas/EventDeliveryLog","kind":"json-schema","title":"EventDeliveryLog","data":{"title":"EventDeliveryLog","type":"object","required":["deliveryDetail","payload"],"properties":{"deliveryDetail":{"$ref":"#/components/schemas/DeliveryDetail"},"payload":{"type":"string"}}}},"components/schemas/EventDeliveryStatus":{"id":"components/schemas/EventDeliveryStatus","kind":"json-schema","title":"EventDeliveryStatus","data":{"title":"EventDeliveryStatus","type":"object","required":["event","deliveryStatus"],"properties":{"event":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"type":"string"},"deliveryStatus":{"$ref":"#/components/schemas/DeliveryStatus"}}}},"components/schemas/Exception":{"id":"components/schemas/Exception","kind":"json-schema","title":"Exception","data":{"title":"Exception","type":"object"}},"components/schemas/Exception1":{"id":"components/schemas/Exception1","kind":"json-schema","title":"Exception","data":{"title":"Exception","type":"object"}},"components/schemas/ExcludesAll":{"id":"components/schemas/ExcludesAll","kind":"json-schema","title":"ExcludesAll","data":{"title":"ExcludesAll","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/ExcludesOne":{"id":"components/schemas/ExcludesOne","kind":"json-schema","title":"ExcludesOne","data":{"title":"ExcludesOne","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/FacebookMessengerAttributes":{"id":"components/schemas/FacebookMessengerAttributes","kind":"json-schema","title":"FacebookMessengerAttributes","data":{"title":"FacebookMessengerAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}},"components/schemas/FacebookMessengerConversation":{"id":"components/schemas/FacebookMessengerConversation","kind":"json-schema","title":"FacebookMessengerConversation","data":{"title":"FacebookMessengerConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/Failure":{"id":"components/schemas/Failure","kind":"json-schema","title":"Failure","data":{"title":"Failure","type":"object","required":["error"],"properties":{"error":{"$ref":"#/components/schemas/ChannelAvailabilityError"}}}},"components/schemas/Field":{"id":"components/schemas/Field","kind":"json-schema","title":"Field","data":{"title":"Field","type":"object","required":["name"],"properties":{"name":{"type":"string"},"field":{"$ref":"#/components/schemas/FieldType"}}}},"components/schemas/FieldCanHaveMultipleValuesOrBeEmptyOperator":{"id":"components/schemas/FieldCanHaveMultipleValuesOrBeEmptyOperator","kind":"json-schema","title":"FieldCanHaveMultipleValuesOrBeEmptyOperator","data":{"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"}]}},"components/schemas/FieldCanHaveSingleValueOrBeEmptyOperator":{"id":"components/schemas/FieldCanHaveSingleValueOrBeEmptyOperator","kind":"json-schema","title":"FieldCanHaveSingleValueOrBeEmptyOperator","data":{"title":"FieldCanHaveSingleValueOrBeEmptyOperator","oneOf":[{"$ref":"#/components/schemas/IsEmpty"},{"$ref":"#/components/schemas/IsNotEmpty"},{"$ref":"#/components/schemas/IsNotOneOf"},{"$ref":"#/components/schemas/IsOneOf"}]}},"components/schemas/FieldHasSingleValueOperator":{"id":"components/schemas/FieldHasSingleValueOperator","kind":"json-schema","title":"FieldHasSingleValueOperator","data":{"title":"FieldHasSingleValueOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf"},{"$ref":"#/components/schemas/IsOneOf"}]}},"components/schemas/FieldMetadata":{"id":"components/schemas/FieldMetadata","kind":"json-schema","title":"FieldMetadata","data":{"title":"FieldMetadata","type":"object","required":["field","description","nullable"],"properties":{"field":{"type":"string"},"description":{"type":"string"},"nullable":{"type":"boolean"}}}},"components/schemas/FieldType":{"id":"components/schemas/FieldType","kind":"json-schema","title":"FieldType","data":{"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"}]}},"components/schemas/File":{"id":"components/schemas/File","kind":"json-schema","title":"File","data":{"title":"File","type":"object","required":["url"],"properties":{"url":{"description":"url","type":"string"},"prettyName":{"type":"string"}}}},"components/schemas/FileMeta":{"id":"components/schemas/FileMeta","kind":"json-schema","title":"FileMeta","data":{"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"}}}},"components/schemas/Filter":{"id":"components/schemas/Filter","kind":"json-schema","title":"Filter","data":{"title":"Filter","type":"object","required":["attribute"],"properties":{"attribute":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/FilterMetadata":{"id":"components/schemas/FilterMetadata","kind":"json-schema","title":"FilterMetadata","data":{"title":"FilterMetadata","type":"object","required":["filterAttribute"],"properties":{"filterAttribute":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/FilterValue":{"id":"components/schemas/FilterValue","kind":"json-schema","title":"FilterValue","data":{"title":"FilterValue","type":"object","required":["value"],"properties":{"value":{"type":"string"},"label":{"type":"string"}}}},"components/schemas/Filters":{"id":"components/schemas/Filters","kind":"json-schema","title":"Filters","data":{"title":"Filters","type":"object","required":["strategy"],"properties":{"strategy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [All, Any]"},"children":[]}]}]}],"type":"string"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}}}}},"components/schemas/Filters1":{"id":"components/schemas/Filters1","kind":"json-schema","title":"Filters","data":{"title":"Filters","oneOf":[{"$ref":"#/components/schemas/CombinedFilters"}]}},"components/schemas/FollowUp":{"id":"components/schemas/FollowUp","kind":"json-schema","title":"FollowUp","data":{"title":"FollowUp","type":"object","required":["parentId"],"properties":{"parentId":{"type":"integer","format":"int64"}}}},"components/schemas/FollowupAddedActivityType":{"id":"components/schemas/FollowupAddedActivityType","kind":"json-schema","title":"FollowupAddedActivityType","data":{"title":"FollowupAddedActivityType","type":"object"}},"components/schemas/FollowupConversationInput":{"id":"components/schemas/FollowupConversationInput","kind":"json-schema","title":"FollowupConversationInput","data":{"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 to followup the conversation","type":"string","format":"uuid"}}}},"components/schemas/FollowupExpiredActivityType":{"id":"components/schemas/FollowupExpiredActivityType","kind":"json-schema","title":"FollowupExpiredActivityType","data":{"title":"FollowupExpiredActivityType","type":"object"}},"components/schemas/FollowupRemovedActivityType":{"id":"components/schemas/FollowupRemovedActivityType","kind":"json-schema","title":"FollowupRemovedActivityType","data":{"title":"FollowupRemovedActivityType","type":"object"}},"components/schemas/FormAttributeValue":{"id":"components/schemas/FormAttributeValue","kind":"json-schema","title":"FormAttributeValue","data":{"title":"FormAttributeValue","oneOf":[{"$ref":"#/components/schemas/Attachments"},{"$ref":"#/components/schemas/Select"},{"$ref":"#/components/schemas/Text1"}]}},"components/schemas/FormSubmission":{"id":"components/schemas/FormSubmission","kind":"json-schema","title":"FormSubmission","data":{"title":"FormSubmission","type":"object","required":["values"],"properties":{"values":{"$ref":"#/components/schemas/Map_FormAttributeValue"}}}},"components/schemas/FulfillmentLineItem":{"id":"components/schemas/FulfillmentLineItem","kind":"json-schema","title":"FulfillmentLineItem","data":{"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"}}}},"components/schemas/GenericAttributes":{"id":"components/schemas/GenericAttributes","kind":"json-schema","title":"GenericAttributes","data":{"title":"GenericAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}},"components/schemas/GenericChannel":{"id":"components/schemas/GenericChannel","kind":"json-schema","title":"GenericChannel","data":{"title":"GenericChannel","type":"object","required":["genericChannelName","availability"],"properties":{"genericChannelName":{"type":"string"},"availability":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Available, NotAvailable]"},"children":[]}]}]}],"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"}}}},"components/schemas/GenericConversation":{"id":"components/schemas/GenericConversation","kind":"json-schema","title":"GenericConversation","data":{"title":"GenericConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"fromContactPointId":{"type":"string"},"toContactPointId":{"type":"string"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/GenericConversationImport":{"id":"components/schemas/GenericConversationImport","kind":"json-schema","title":"GenericConversationImport","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Connected, Disconnected]"},"children":[]}]}]}],"type":"string"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Outbound]"},"children":[]}]}]}],"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."}}}},"components/schemas/Genericapimessaging":{"id":"components/schemas/Genericapimessaging","kind":"json-schema","title":"Genericapimessaging","data":{"title":"Genericapimessaging","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Dixa user associated with the AI agent, used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a message"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/GetActivityLogOutput":{"id":"components/schemas/GetActivityLogOutput","kind":"json-schema","title":"GetActivityLogOutput","data":{"title":"GetActivityLogOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityLogEntry"}}}}},"components/schemas/GetBusinessHoursScheduleDefinitionOutput":{"id":"components/schemas/GetBusinessHoursScheduleDefinitionOutput","kind":"json-schema","title":"GetBusinessHoursScheduleDefinitionOutput","data":{"title":"GetBusinessHoursScheduleDefinitionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetBusinessHoursScheduleDefinitionResult"}}}},"components/schemas/GetBusinessHoursScheduleDefinitionResult":{"id":"components/schemas/GetBusinessHoursScheduleDefinitionResult","kind":"json-schema","title":"GetBusinessHoursScheduleDefinitionResult","data":{"title":"GetBusinessHoursScheduleDefinitionResult","type":"object","required":["schedule"],"properties":{"schedule":{"$ref":"#/components/schemas/BusinessHoursScheduleDefinition"}}}},"components/schemas/GetBusinessOpenStatusOutput":{"id":"components/schemas/GetBusinessOpenStatusOutput","kind":"json-schema","title":"GetBusinessOpenStatusOutput","data":{"title":"GetBusinessOpenStatusOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetBusinessOpenStatusResult"}}}},"components/schemas/GetBusinessOpenStatusResult":{"id":"components/schemas/GetBusinessOpenStatusResult","kind":"json-schema","title":"GetBusinessOpenStatusResult","data":{"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"}}}},"components/schemas/GetContactPointByIdOutput":{"id":"components/schemas/GetContactPointByIdOutput","kind":"json-schema","title":"GetContactPointByIdOutput","data":{"title":"GetContactPointByIdOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ContactEndpoint"}}}},"components/schemas/GetConversationOutput":{"id":"components/schemas/GetConversationOutput","kind":"json-schema","title":"GetConversationOutput","data":{"title":"GetConversationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Conversation"}}}},"components/schemas/GetCustomAttributesDefinitionsOutput":{"id":"components/schemas/GetCustomAttributesDefinitionsOutput","kind":"json-schema","title":"GetCustomAttributesDefinitionsOutput","data":{"title":"GetCustomAttributesDefinitionsOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CustomAttributeDefinition"}}}},"components/schemas/GetEndUserOutput":{"id":"components/schemas/GetEndUserOutput","kind":"json-schema","title":"GetEndUserOutput","data":{"title":"GetEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}}},"components/schemas/GetFilterValuesOutput":{"id":"components/schemas/GetFilterValuesOutput","kind":"json-schema","title":"GetFilterValuesOutput","data":{"title":"GetFilterValuesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FilterValue"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/GetKnowledgeArticleOutput":{"id":"components/schemas/GetKnowledgeArticleOutput","kind":"json-schema","title":"GetKnowledgeArticleOutput","data":{"title":"GetKnowledgeArticleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Article"}}}},"components/schemas/GetKnowledgeArticleTranslationsOutput":{"id":"components/schemas/GetKnowledgeArticleTranslationsOutput","kind":"json-schema","title":"GetKnowledgeArticleTranslationsOutput","data":{"title":"GetKnowledgeArticleTranslationsOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ArticleTranslations"}}}},"components/schemas/GetKnowledgeCategoryOutput":{"id":"components/schemas/GetKnowledgeCategoryOutput","kind":"json-schema","title":"GetKnowledgeCategoryOutput","data":{"title":"GetKnowledgeCategoryOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Category"}}}},"components/schemas/GetKnowledgeCategoryTranslationsOutput":{"id":"components/schemas/GetKnowledgeCategoryTranslationsOutput","kind":"json-schema","title":"GetKnowledgeCategoryTranslationsOutput","data":{"title":"GetKnowledgeCategoryTranslationsOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CategoryTranslations"}}}},"components/schemas/GetKnowledgeCollectionCatalogOutput":{"id":"components/schemas/GetKnowledgeCollectionCatalogOutput","kind":"json-schema","title":"GetKnowledgeCollectionCatalogOutput","data":{"title":"GetKnowledgeCollectionCatalogOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/CollectionCatalogItem"}}}},"components/schemas/GetKnowledgeCollectionOutput":{"id":"components/schemas/GetKnowledgeCollectionOutput","kind":"json-schema","title":"GetKnowledgeCollectionOutput","data":{"title":"GetKnowledgeCollectionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Collection"}}}},"components/schemas/GetMetricDataInput":{"id":"components/schemas/GetMetricDataInput","kind":"json-schema","title":"GetMetricDataInput","data":{"title":"GetMetricDataInput","oneOf":[{"$ref":"#/components/schemas/GetMetricDataInputCsidFilter"},{"$ref":"#/components/schemas/GetMetricDataInputPeriodFilter"}]}},"components/schemas/GetMetricDataInputCsidFilter":{"id":"components/schemas/GetMetricDataInputCsidFilter","kind":"json-schema","title":"GetMetricDataInputCsidFilter","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]"},"children":[]}]}]}],"type":"string"}},"timezone":{"type":"string"}}}},"components/schemas/GetMetricDataInputPeriodFilter":{"id":"components/schemas/GetMetricDataInputPeriodFilter","kind":"json-schema","title":"GetMetricDataInputPeriodFilter","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Min, Max, Sum, Count, Percentage, AgentPresenceDuration, StdDev, Average]"},"children":[]}]}]}],"type":"string"}},"timezone":{"type":"string"}}}},"components/schemas/GetMetricDataOutput":{"id":"components/schemas/GetMetricDataOutput","kind":"json-schema","title":"GetMetricDataOutput","data":{"title":"GetMetricDataOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricData"}}}},"components/schemas/GetMetricOutput":{"id":"components/schemas/GetMetricOutput","kind":"json-schema","title":"GetMetricOutput","data":{"title":"GetMetricOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricMetadata"}}}},"components/schemas/GetMetricRecordOutput":{"id":"components/schemas/GetMetricRecordOutput","kind":"json-schema","title":"GetMetricRecordOutput","data":{"title":"GetMetricRecordOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/MetricRecordMetadata"}}}},"components/schemas/GetMetricRecordsDataInput":{"id":"components/schemas/GetMetricRecordsDataInput","kind":"json-schema","title":"GetMetricRecordsDataInput","data":{"title":"GetMetricRecordsDataInput","oneOf":[{"$ref":"#/components/schemas/GetMetricRecordsDataInputCsidFilter"},{"$ref":"#/components/schemas/GetMetricRecordsDataInputPeriodFilter"}]}},"components/schemas/GetMetricRecordsDataInputCsidFilter":{"id":"components/schemas/GetMetricRecordsDataInputCsidFilter","kind":"json-schema","title":"GetMetricRecordsDataInputCsidFilter","data":{"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"}}}},"components/schemas/GetMetricRecordsDataInputPeriodFilter":{"id":"components/schemas/GetMetricRecordsDataInputPeriodFilter","kind":"json-schema","title":"GetMetricRecordsDataInputPeriodFilter","data":{"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"}}}},"components/schemas/GetMetricRecordsDataOutput":{"id":"components/schemas/GetMetricRecordsDataOutput","kind":"json-schema","title":"GetMetricRecordsDataOutput","data":{"title":"GetMetricRecordsDataOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricRecord"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/GetMetricRecordsOutput":{"id":"components/schemas/GetMetricRecordsOutput","kind":"json-schema","title":"GetMetricRecordsOutput","data":{"title":"GetMetricRecordsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricRecordMetadata"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/GetMetricsOutput":{"id":"components/schemas/GetMetricsOutput","kind":"json-schema","title":"GetMetricsOutput","data":{"title":"GetMetricsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MetricMetadata"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/GetOrganizationOutput":{"id":"components/schemas/GetOrganizationOutput","kind":"json-schema","title":"GetOrganizationOutput","data":{"title":"GetOrganizationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/OrganizationDetails"}}}},"components/schemas/GetQueueByIdOutput":{"id":"components/schemas/GetQueueByIdOutput","kind":"json-schema","title":"GetQueueByIdOutput","data":{"title":"GetQueueByIdOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Queue1"}}}},"components/schemas/GetQueuedConversationPositionOutput":{"id":"components/schemas/GetQueuedConversationPositionOutput","kind":"json-schema","title":"GetQueuedConversationPositionOutput","data":{"title":"GetQueuedConversationPositionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/QueuedConversation"}}}},"components/schemas/GetTagOutput":{"id":"components/schemas/GetTagOutput","kind":"json-schema","title":"GetTagOutput","data":{"title":"GetTagOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Tag"}}}},"components/schemas/GetUpcomingBusinessHoursScheduleOutput":{"id":"components/schemas/GetUpcomingBusinessHoursScheduleOutput","kind":"json-schema","title":"GetUpcomingBusinessHoursScheduleOutput","data":{"title":"GetUpcomingBusinessHoursScheduleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/GetUpcomingBusinessHoursScheduleResult"}}}},"components/schemas/GetUpcomingBusinessHoursScheduleResult":{"id":"components/schemas/GetUpcomingBusinessHoursScheduleResult","kind":"json-schema","title":"GetUpcomingBusinessHoursScheduleResult","data":{"title":"GetUpcomingBusinessHoursScheduleResult","type":"object","required":["schedule"],"properties":{"schedule":{"$ref":"#/components/schemas/BusinessHoursUpcomingSchedule"}}}},"components/schemas/GetWebhookEventDeliveryLogsOutput":{"id":"components/schemas/GetWebhookEventDeliveryLogsOutput","kind":"json-schema","title":"GetWebhookEventDeliveryLogsOutput","data":{"title":"GetWebhookEventDeliveryLogsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventDeliveryLog"}}}}},"components/schemas/GetWebhookLastDeliveryStatusOutput":{"id":"components/schemas/GetWebhookLastDeliveryStatusOutput","kind":"json-schema","title":"GetWebhookLastDeliveryStatusOutput","data":{"title":"GetWebhookLastDeliveryStatusOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventDeliveryStatus"}}}}},"components/schemas/GetWebhookSubscriptionOutput":{"id":"components/schemas/GetWebhookSubscriptionOutput","kind":"json-schema","title":"GetWebhookSubscriptionOutput","data":{"title":"GetWebhookSubscriptionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"components/schemas/GetWhatsappTemplateOutput":{"id":"components/schemas/GetWhatsappTemplateOutput","kind":"json-schema","title":"GetWhatsappTemplateOutput","data":{"title":"GetWhatsappTemplateOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WhatsappTemplate"}}}},"components/schemas/HelpCenterLink":{"id":"components/schemas/HelpCenterLink","kind":"json-schema","title":"HelpCenterLink","data":{"title":"HelpCenterLink","type":"object","required":["id","name","url"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"}}}},"components/schemas/Holiday":{"id":"components/schemas/Holiday","kind":"json-schema","title":"Holiday","data":{"title":"Holiday","type":"object"}},"components/schemas/Holiday1":{"id":"components/schemas/Holiday1","kind":"json-schema","title":"Holiday","data":{"title":"Holiday","type":"object"}},"components/schemas/Html":{"id":"components/schemas/Html","kind":"json-schema","title":"Html","data":{"title":"Html","type":"object","required":["value"],"properties":{"value":{"type":"string"}}}},"components/schemas/ImportConversationOutput":{"id":"components/schemas/ImportConversationOutput","kind":"json-schema","title":"ImportConversationOutput","data":{"title":"ImportConversationOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ImportConversationResponse"}}}},"components/schemas/ImportConversationResponse":{"id":"components/schemas/ImportConversationResponse","kind":"json-schema","title":"ImportConversationResponse","data":{"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"}}}}},"components/schemas/ImportMessageInput":{"id":"components/schemas/ImportMessageInput","kind":"json-schema","title":"ImportMessageInput","data":{"title":"ImportMessageInput","oneOf":[{"$ref":"#/components/schemas/InboundImport"},{"$ref":"#/components/schemas/OutboundImport"}]}},"components/schemas/Inbound":{"id":"components/schemas/Inbound","kind":"json-schema","title":"Inbound","data":{"title":"Inbound","type":"object","required":["content"],"properties":{"content":{"$ref":"#/components/schemas/Content"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}},"integrationEmail":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal email address registered for the integration with format: <email-address>@email.dixa.io"},"children":[]}]}]}],"type":"string"},"externalId":{"description":"Client generated identifier for external reference","type":"string"}}}},"components/schemas/InboundImport":{"id":"components/schemas/InboundImport","kind":"json-schema","title":"InboundImport","data":{"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."}}}},"components/schemas/IncludesAll":{"id":"components/schemas/IncludesAll","kind":"json-schema","title":"IncludesAll","data":{"title":"IncludesAll","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/IncludesOne":{"id":"components/schemas/IncludesOne","kind":"json-schema","title":"IncludesOne","data":{"title":"IncludesOne","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/Infrastructure":{"id":"components/schemas/Infrastructure","kind":"json-schema","title":"Infrastructure","data":{"title":"Infrastructure","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/InheritedRestriction":{"id":"components/schemas/InheritedRestriction","kind":"json-schema","title":"InheritedRestriction","data":{"title":"InheritedRestriction","type":"object","properties":{"fromCollection":{"type":"string"},"fromCategory":{"type":"string"}}}},"components/schemas/InstantField":{"id":"components/schemas/InstantField","kind":"json-schema","title":"InstantField","data":{"title":"InstantField","type":"object","required":["value"],"properties":{"value":{"type":"string","format":"date-time"}}}},"components/schemas/IntField":{"id":"components/schemas/IntField","kind":"json-schema","title":"IntField","data":{"title":"IntField","type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"int32"}}}},"components/schemas/Integrity":{"id":"components/schemas/Integrity","kind":"json-schema","title":"Integrity","data":{"title":"Integrity","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/InternalNoteData":{"id":"components/schemas/InternalNoteData","kind":"json-schema","title":"InternalNoteData","data":{"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"}}}},"components/schemas/Interval":{"id":"components/schemas/Interval","kind":"json-schema","title":"Interval","data":{"title":"Interval","type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time"},"end":{"type":"string","format":"date-time"}}}},"components/schemas/InvalidArgument":{"id":"components/schemas/InvalidArgument","kind":"json-schema","title":"InvalidArgument","data":{"title":"InvalidArgument","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/IsEmpty":{"id":"components/schemas/IsEmpty","kind":"json-schema","title":"IsEmpty","data":{"title":"IsEmpty","type":"object"}},"components/schemas/IsNotEmpty":{"id":"components/schemas/IsNotEmpty","kind":"json-schema","title":"IsNotEmpty","data":{"title":"IsNotEmpty","type":"object"}},"components/schemas/IsNotOneOf":{"id":"components/schemas/IsNotOneOf","kind":"json-schema","title":"IsNotOneOf","data":{"title":"IsNotOneOf","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/IsNotOneOf1":{"id":"components/schemas/IsNotOneOf1","kind":"json-schema","title":"IsNotOneOf","data":{"title":"IsNotOneOf","type":"object","required":["values"],"properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [email, contactform, chat, dixamessenger, phone, voicemail, callback, sms, facebookmessenger, whatsapp, adachat, digitalgeniuschat, kindlychat, genericapimessaging, trustpilot, yotpo]"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/IsNotOneOf2":{"id":"components/schemas/IsNotOneOf2","kind":"json-schema","title":"IsNotOneOf","data":{"title":"IsNotOneOf","type":"object","properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of arrays of strings. Each inner array represents a possible custom attribute value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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\"]]."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If custom attribute is of type Text, each search value must be wrapped in an array too. Example: [[\"value1\"]]"},"children":[]}]}]}],"type":"array","items":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/IsNotOneOf3":{"id":"components/schemas/IsNotOneOf3","kind":"json-schema","title":"IsNotOneOf","data":{"title":"IsNotOneOf","type":"object","required":["values"],"properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [inbound, outbound, internal]"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/IsNotOneOf4":{"id":"components/schemas/IsNotOneOf4","kind":"json-schema","title":"IsNotOneOf","data":{"title":"IsNotOneOf","type":"object","required":["values"],"properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [open, closed, pending]"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/IsNotOneOf5":{"id":"components/schemas/IsNotOneOf5","kind":"json-schema","title":"IsNotOneOf","data":{"title":"IsNotOneOf","type":"object","required":["field","values"],"properties":{"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [InitialChannel, OperationOrigin, QueueId]"},"children":[]}]}]}],"type":"string"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}}},"components/schemas/IsOneOf":{"id":"components/schemas/IsOneOf","kind":"json-schema","title":"IsOneOf","data":{"title":"IsOneOf","type":"object","properties":{"values":{"type":"array","items":{"type":"string"}}}}},"components/schemas/IsOneOf1":{"id":"components/schemas/IsOneOf1","kind":"json-schema","title":"IsOneOf","data":{"title":"IsOneOf","type":"object","required":["values"],"properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [email, contactform, chat, dixamessenger, phone, voicemail, callback, sms, facebookmessenger, whatsapp, adachat, digitalgeniuschat, kindlychat, genericapimessaging, trustpilot, yotpo]"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/IsOneOf2":{"id":"components/schemas/IsOneOf2","kind":"json-schema","title":"IsOneOf","data":{"title":"IsOneOf","type":"object","properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of arrays of strings. Each inner array represents a possible custom attribute value."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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\"]]."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If custom attribute is of type Text, each search value must be wrapped in an array too. Example: [[\"value1\"]]"},"children":[]}]}]}],"type":"array","items":{"type":"array","items":{"type":"string"}}}}}},"components/schemas/IsOneOf3":{"id":"components/schemas/IsOneOf3","kind":"json-schema","title":"IsOneOf","data":{"title":"IsOneOf","type":"object","required":["values"],"properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [inbound, outbound, internal]"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/IsOneOf4":{"id":"components/schemas/IsOneOf4","kind":"json-schema","title":"IsOneOf","data":{"title":"IsOneOf","type":"object","required":["values"],"properties":{"values":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [open, closed, pending]"},"children":[]}]}]}],"type":"array","items":{"type":"string"}}}}},"components/schemas/IsOneOf5":{"id":"components/schemas/IsOneOf5","kind":"json-schema","title":"IsOneOf","data":{"title":"IsOneOf","type":"object","required":["field","values"],"properties":{"field":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [InitialChannel, OperationOrigin, QueueId]"},"children":[]}]}]}],"type":"string"},"values":{"type":"array","minItems":1,"items":{"type":"string"}}}}},"components/schemas/Kindly":{"id":"components/schemas/Kindly","kind":"json-schema","title":"Kindly","data":{"title":"Kindly","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Dixa user associated with the AI agent, used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a message"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/LastActivity":{"id":"components/schemas/LastActivity","kind":"json-schema","title":"LastActivity","data":{"title":"LastActivity","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}}},"components/schemas/LastMessage":{"id":"components/schemas/LastMessage","kind":"json-schema","title":"LastMessage","data":{"title":"LastMessage","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/TimestampOperator"}}}},"components/schemas/LineItem":{"id":"components/schemas/LineItem","kind":"json-schema","title":"LineItem","data":{"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"}}}},"components/schemas/LinkConversationInput":{"id":"components/schemas/LinkConversationInput","kind":"json-schema","title":"LinkConversationInput","data":{"title":"LinkConversationInput","type":"object","required":["parentId","linkType"],"properties":{"parentId":{"type":"integer","format":"int64"},"linkType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Related, SideConversation]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/ListActivityLogOutput":{"id":"components/schemas/ListActivityLogOutput","kind":"json-schema","title":"ListActivityLogOutput","data":{"title":"ListActivityLogOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityLogEntry"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/ListAgentsOutput":{"id":"components/schemas/ListAgentsOutput","kind":"json-schema","title":"ListAgentsOutput","data":{"title":"ListAgentsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/ListAiAgentsOutput":{"id":"components/schemas/ListAiAgentsOutput","kind":"json-schema","title":"ListAiAgentsOutput","data":{"title":"ListAiAgentsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AiAgent"}}}}},"components/schemas/ListBusinessHoursSchedulesOutput":{"id":"components/schemas/ListBusinessHoursSchedulesOutput","kind":"json-schema","title":"ListBusinessHoursSchedulesOutput","data":{"title":"ListBusinessHoursSchedulesOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ListBusinessHoursSchedulesResult"}}}},"components/schemas/ListBusinessHoursSchedulesResult":{"id":"components/schemas/ListBusinessHoursSchedulesResult","kind":"json-schema","title":"ListBusinessHoursSchedulesResult","data":{"title":"ListBusinessHoursSchedulesResult","type":"object","properties":{"schedules":{"type":"array","items":{"$ref":"#/components/schemas/BusinessHoursSchedule"}}}}},"components/schemas/ListContactPointsOutput":{"id":"components/schemas/ListContactPointsOutput","kind":"json-schema","title":"ListContactPointsOutput","data":{"title":"ListContactPointsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactEndpoint"}}}}},"components/schemas/ListConversationRatingsOutput":{"id":"components/schemas/ListConversationRatingsOutput","kind":"json-schema","title":"ListConversationRatingsOutput","data":{"title":"ListConversationRatingsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationRating"}}}}},"components/schemas/ListCustomAttributesDefinitionsOutput":{"id":"components/schemas/ListCustomAttributesDefinitionsOutput","kind":"json-schema","title":"ListCustomAttributesDefinitionsOutput","data":{"title":"ListCustomAttributesDefinitionsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttributeDefinition"}}}}},"components/schemas/ListEndUserConversationsOutput":{"id":"components/schemas/ListEndUserConversationsOutput","kind":"json-schema","title":"ListEndUserConversationsOutput","data":{"title":"ListEndUserConversationsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/ListEndUsersOutput":{"id":"components/schemas/ListEndUsersOutput","kind":"json-schema","title":"ListEndUsersOutput","data":{"title":"ListEndUsersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EndUser"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/ListField":{"id":"components/schemas/ListField","kind":"json-schema","title":"ListField","data":{"title":"ListField","type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PrimitiveField"}}}}},"components/schemas/ListFlowsOutput":{"id":"components/schemas/ListFlowsOutput","kind":"json-schema","title":"ListFlowsOutput","data":{"title":"ListFlowsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationFlow"}}}}},"components/schemas/ListInternalNotesOutput":{"id":"components/schemas/ListInternalNotesOutput","kind":"json-schema","title":"ListInternalNotesOutput","data":{"title":"ListInternalNotesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InternalNoteData"}}}}},"components/schemas/ListKnowledgeCollectionsOutput":{"id":"components/schemas/ListKnowledgeCollectionsOutput","kind":"json-schema","title":"ListKnowledgeCollectionsOutput","data":{"title":"ListKnowledgeCollectionsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Collection"}}}}},"components/schemas/ListLinkedConversationsOutput":{"id":"components/schemas/ListLinkedConversationsOutput","kind":"json-schema","title":"ListLinkedConversationsOutput","data":{"title":"ListLinkedConversationsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Conversation"}}}}},"components/schemas/ListMessagesOutput":{"id":"components/schemas/ListMessagesOutput","kind":"json-schema","title":"ListMessagesOutput","data":{"title":"ListMessagesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}}},"components/schemas/ListPresenceOutput":{"id":"components/schemas/ListPresenceOutput","kind":"json-schema","title":"ListPresenceOutput","data":{"title":"ListPresenceOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserPresence"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/ListQueuesOutput":{"id":"components/schemas/ListQueuesOutput","kind":"json-schema","title":"ListQueuesOutput","data":{"title":"ListQueuesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Queue1"}}}}},"components/schemas/ListTagsOutput":{"id":"components/schemas/ListTagsOutput","kind":"json-schema","title":"ListTagsOutput","data":{"title":"ListTagsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}},"components/schemas/ListTeamMembersOutput":{"id":"components/schemas/ListTeamMembersOutput","kind":"json-schema","title":"ListTeamMembersOutput","data":{"title":"ListTeamMembersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TeamMember"}}}}},"components/schemas/ListTeamsOutput":{"id":"components/schemas/ListTeamsOutput","kind":"json-schema","title":"ListTeamsOutput","data":{"title":"ListTeamsOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Team1"}}}}},"components/schemas/ListTemplatesOutput":{"id":"components/schemas/ListTemplatesOutput","kind":"json-schema","title":"ListTemplatesOutput","data":{"title":"ListTemplatesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Template"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/ListWebhookSubscriptionsEndpointOutput":{"id":"components/schemas/ListWebhookSubscriptionsEndpointOutput","kind":"json-schema","title":"ListWebhookSubscriptionsEndpointOutput","data":{"title":"ListWebhookSubscriptionsEndpointOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}}}}},"components/schemas/ListWhatsappTemplatesOutput":{"id":"components/schemas/ListWhatsappTemplatesOutput","kind":"json-schema","title":"ListWhatsappTemplatesOutput","data":{"title":"ListWhatsappTemplatesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WhatsappTemplateListItem"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/LongAggregateValue":{"id":"components/schemas/LongAggregateValue","kind":"json-schema","title":"LongAggregateValue","data":{"title":"LongAggregateValue","type":"object","required":["value","measure"],"properties":{"value":{"type":"integer","format":"int64"},"measure":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Count]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/LongField":{"id":"components/schemas/LongField","kind":"json-schema","title":"LongField","data":{"title":"LongField","type":"object","required":["value"],"properties":{"value":{"type":"integer","format":"int64"}}}},"components/schemas/LongerThanOrEqualTo":{"id":"components/schemas/LongerThanOrEqualTo","kind":"json-schema","title":"LongerThanOrEqualTo","data":{"title":"LongerThanOrEqualTo","description":"In milliseconds; for example: '10800000' (3 hours)","type":"object","required":["duration"],"properties":{"duration":{"type":"integer","format":"int64"}}}},"components/schemas/Map_AttributeValue":{"id":"components/schemas/Map_AttributeValue","kind":"json-schema","title":"Map_AttributeValue","data":{"title":"Map_AttributeValue","type":"object","additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text"},"children":[]}]}]}],"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"components/schemas/Map_ConversationChannel_Int":{"id":"components/schemas/Map_ConversationChannel_Int","kind":"json-schema","title":"Map_ConversationChannel_Int","data":{"title":"Map_ConversationChannel_Int","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"integer","format":"int32"}}},"components/schemas/Map_ConversationChannel_Set_String":{"id":"components/schemas/Map_ConversationChannel_Set_String","kind":"json-schema","title":"Map_ConversationChannel_Set_String","data":{"title":"Map_ConversationChannel_Set_String","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"array","uniqueItems":true,"items":{"type":"string"}}}},"components/schemas/Map_FormAttributeValue":{"id":"components/schemas/Map_FormAttributeValue","kind":"json-schema","title":"Map_FormAttributeValue","data":{"title":"Map_FormAttributeValue","type":"object","additionalProperties":{"$ref":"#/components/schemas/FormAttributeValue"}}},"components/schemas/Map_QueueThreshold_Int":{"id":"components/schemas/Map_QueueThreshold_Int","kind":"json-schema","title":"Map_QueueThreshold_Int","data":{"title":"Map_QueueThreshold_Int","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [SlaTimeLimit, AvailableAgents, LongestWait, SlaPercentage, WaitingConversations]"},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"integer","format":"int32"}}},"components/schemas/Map_String":{"id":"components/schemas/Map_String","kind":"json-schema","title":"Map_String","data":{"title":"Map_String","type":"object","additionalProperties":{"type":"string"}}},"components/schemas/Map_UUID_Option_AttributeValue":{"id":"components/schemas/Map_UUID_Option_AttributeValue","kind":"json-schema","title":"Map_UUID_Option_AttributeValue","data":{"title":"Map_UUID_Option_AttributeValue","type":"object","additionalProperties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text"},"children":[]}]}]}],"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]}}},"components/schemas/Map_Vector_String":{"id":"components/schemas/Map_Vector_String","kind":"json-schema","title":"Map_Vector_String","data":{"title":"Map_Vector_String","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Snippet of text where a match was found. Matched text will be wrapped in <em> tags."},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"components/schemas/Map_WebhookEventType_Filters":{"id":"components/schemas/Map_WebhookEventType_Filters","kind":"json-schema","title":"Map_WebhookEventType_Filters","data":{"title":"Map_WebhookEventType_Filters","type":"object","additionalProperties":{"$ref":"#/components/schemas/Filters1"}}},"components/schemas/Markdown":{"id":"components/schemas/Markdown","kind":"json-schema","title":"Markdown","data":{"title":"Markdown","type":"object","required":["value"],"properties":{"value":{"type":"string"}}}},"components/schemas/Media":{"id":"components/schemas/Media","kind":"json-schema","title":"Media","data":{"title":"Media","type":"object","required":["body","mediaUrl"],"properties":{"body":{"description":"Template body text; maximum 1024 characters","type":"string"},"mediaUrl":{"type":"string"}}}},"components/schemas/Message":{"id":"components/schemas/Message","kind":"json-schema","title":"Message","data":{"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"}}}},"components/schemas/MessageAddedAttribute":{"id":"components/schemas/MessageAddedAttribute","kind":"json-schema","title":"MessageAddedAttribute","data":{"title":"MessageAddedAttribute","type":"object","required":["messageId"],"properties":{"messageId":{"type":"string"},"fromEndpoint":{"type":"string"},"avatarUrl":{"type":"string"}}}},"components/schemas/MessageAddedByAgentActivityType":{"id":"components/schemas/MessageAddedByAgentActivityType","kind":"json-schema","title":"MessageAddedByAgentActivityType","data":{"title":"MessageAddedByAgentActivityType","type":"object"}},"components/schemas/MessageAddedByCustomerActivityType":{"id":"components/schemas/MessageAddedByCustomerActivityType","kind":"json-schema","title":"MessageAddedByCustomerActivityType","data":{"title":"MessageAddedByCustomerActivityType","type":"object"}},"components/schemas/MessageAnonymizationType":{"id":"components/schemas/MessageAnonymizationType","kind":"json-schema","title":"MessageAnonymizationType","data":{"title":"MessageAnonymizationType","type":"object"}},"components/schemas/MessageRedactedAttribute":{"id":"components/schemas/MessageRedactedAttribute","kind":"json-schema","title":"MessageRedactedAttribute","data":{"title":"MessageRedactedAttribute","type":"object","required":["messageId","wasTextRedacted","numberOfDeletedFiles"],"properties":{"messageId":{"type":"string"},"wasTextRedacted":{"type":"boolean"},"numberOfDeletedFiles":{"type":"integer","format":"int32"}}}},"components/schemas/MessengerConversation":{"id":"components/schemas/MessengerConversation","kind":"json-schema","title":"MessengerConversation","data":{"title":"MessengerConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/MessengerFormAttributes":{"id":"components/schemas/MessengerFormAttributes","kind":"json-schema","title":"MessengerFormAttributes","data":{"title":"MessengerFormAttributes","type":"object","required":["formSubmission"],"properties":{"formSubmission":{"$ref":"#/components/schemas/FormSubmission"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"content":{"$ref":"#/components/schemas/Content"}}}},"components/schemas/MetricData":{"id":"components/schemas/MetricData","kind":"json-schema","title":"MetricData","data":{"title":"MetricData","type":"object","required":["id"],"properties":{"id":{"type":"string"},"aggregates":{"type":"array","items":{"$ref":"#/components/schemas/AggregateValue"}}}}},"components/schemas/MetricMetadata":{"id":"components/schemas/MetricMetadata","kind":"json-schema","title":"MetricMetadata","data":{"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"}}}}},"components/schemas/MetricRecord":{"id":"components/schemas/MetricRecord","kind":"json-schema","title":"MetricRecord","data":{"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"}}}}},"components/schemas/MetricRecordMetadata":{"id":"components/schemas/MetricRecordMetadata","kind":"json-schema","title":"MetricRecordMetadata","data":{"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"}}}}},"components/schemas/MimAutomation":{"id":"components/schemas/MimAutomation","kind":"json-schema","title":"MimAutomation","data":{"title":"MimAutomation","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Dixa user associated with the AI agent, used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a message"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/MimSupport":{"id":"components/schemas/MimSupport","kind":"json-schema","title":"MimSupport","data":{"title":"MimSupport","type":"object","required":["id"],"properties":{"id":{"description":"The ID of the AI agent","type":"string"},"name":{"type":"string"},"systemUserId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Dixa user associated with the AI agent, used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a message"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/MimeType":{"id":"components/schemas/MimeType","kind":"json-schema","title":"MimeType","data":{"title":"MimeType","oneOf":[{"$ref":"#/components/schemas/MimeTypeImpl"}]}},"components/schemas/MimeTypeImpl":{"id":"components/schemas/MimeTypeImpl","kind":"json-schema","title":"MimeTypeImpl","data":{"title":"MimeTypeImpl","type":"object","required":["primary","sub"],"properties":{"primary":{"type":"string"},"sub":{"type":"string"}}}},"components/schemas/Money":{"id":"components/schemas/Money","kind":"json-schema","title":"Money","data":{"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"}}}},"components/schemas/NoAuth":{"id":"components/schemas/NoAuth","kind":"json-schema","title":"NoAuth","data":{"title":"NoAuth","type":"object"}},"components/schemas/NoRecentDelivery":{"id":"components/schemas/NoRecentDelivery","kind":"json-schema","title":"NoRecentDelivery","data":{"title":"NoRecentDelivery","type":"object"}},"components/schemas/NotFound":{"id":"components/schemas/NotFound","kind":"json-schema","title":"NotFound","data":{"title":"NotFound","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/NotFound1":{"id":"components/schemas/NotFound1","kind":"json-schema","title":"NotFound","data":{"title":"NotFound","type":"object","required":["id","message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/NoteAddedActivityType":{"id":"components/schemas/NoteAddedActivityType","kind":"json-schema","title":"NoteAddedActivityType","data":{"title":"NoteAddedActivityType","type":"object"}},"components/schemas/NoteAddedAttribute":{"id":"components/schemas/NoteAddedAttribute","kind":"json-schema","title":"NoteAddedAttribute","data":{"title":"NoteAddedAttribute","type":"object","required":["message"],"properties":{"message":{"type":"string"},"avatarUrl":{"type":"string"}}}},"components/schemas/Nps":{"id":"components/schemas/Nps","kind":"json-schema","title":"Nps","data":{"title":"Nps","type":"object","required":["value"],"properties":{"value":{"description":"Numeric value between 0 and 10 representing the net promoter score.","type":"integer","format":"int32"}}}},"components/schemas/Open":{"id":"components/schemas/Open","kind":"json-schema","title":"Open","data":{"title":"Open","type":"object"}},"components/schemas/Open1":{"id":"components/schemas/Open1","kind":"json-schema","title":"Open","data":{"title":"Open","type":"object"}},"components/schemas/OrderCanceled":{"id":"components/schemas/OrderCanceled","kind":"json-schema","title":"OrderCanceled","data":{"title":"OrderCanceled","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"reason":{"type":"string"}}}},"components/schemas/OrderCreated":{"id":"components/schemas/OrderCreated","kind":"json-schema","title":"OrderCreated","data":{"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"}}}}},"components/schemas/OrderDelivered":{"id":"components/schemas/OrderDelivered","kind":"json-schema","title":"OrderDelivered","data":{"title":"OrderDelivered","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"fulfillmentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External fulfillment ID — links back to the fulfillment"},"children":[]}]}]}],"type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}}},"components/schemas/OrderDrafted":{"id":"components/schemas/OrderDrafted","kind":"json-schema","title":"OrderDrafted","data":{"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"}}}},"components/schemas/OrderFulfilled":{"id":"components/schemas/OrderFulfilled","kind":"json-schema","title":"OrderFulfilled","data":{"title":"OrderFulfilled","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"fulfillmentId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External fulfillment ID — useful for partial fulfillments"},"children":[]}]}]}],"type":"string"},"trackingNumber":{"type":"string"},"trackingUrl":{"type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}}},"components/schemas/OrganizationDetails":{"id":"components/schemas/OrganizationDetails","kind":"json-schema","title":"OrganizationDetails","data":{"title":"OrganizationDetails","type":"object","required":["id","name","subdomain","status"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"subdomain":{"type":"string"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Active, Suspended]"},"children":[]}]}]}],"type":"string"},"avatarUrl":{"type":"string"}}}},"components/schemas/Outbound":{"id":"components/schemas/Outbound","kind":"json-schema","title":"Outbound","data":{"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"}}}}},"components/schemas/OutboundImport":{"id":"components/schemas/OutboundImport","kind":"json-schema","title":"OutboundImport","data":{"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."}}}},"components/schemas/PaginationLinks":{"id":"components/schemas/PaginationLinks","kind":"json-schema","title":"PaginationLinks","data":{"title":"PaginationLinks","type":"object","properties":{"previous":{"description":"url","type":"string"},"next":{"description":"url","type":"string"}}}},"components/schemas/PartialError":{"id":"components/schemas/PartialError","kind":"json-schema","title":"PartialError","data":{"title":"PartialError","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/PatchAgentInput":{"id":"components/schemas/PatchAgentInput","kind":"json-schema","title":"PatchAgentInput","data":{"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"}}}},"components/schemas/PatchConversationCustomAttributesOutput":{"id":"components/schemas/PatchConversationCustomAttributesOutput","kind":"json-schema","title":"PatchConversationCustomAttributesOutput","data":{"title":"PatchConversationCustomAttributesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}}}}},"components/schemas/PatchEndUserCustomAttributesOutput":{"id":"components/schemas/PatchEndUserCustomAttributesOutput","kind":"json-schema","title":"PatchEndUserCustomAttributesOutput","data":{"title":"PatchEndUserCustomAttributesOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomAttribute"}}}}},"components/schemas/PatchEndUserInput":{"id":"components/schemas/PatchEndUserInput","kind":"json-schema","title":"PatchEndUserInput","data":{"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"}}}},"components/schemas/PatchEndUserOutput":{"id":"components/schemas/PatchEndUserOutput","kind":"json-schema","title":"PatchEndUserOutput","data":{"title":"PatchEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}}},"components/schemas/PatchWebhookSubscriptionInput":{"id":"components/schemas/PatchWebhookSubscriptionInput","kind":"json-schema","title":"PatchWebhookSubscriptionInput","data":{"title":"PatchWebhookSubscriptionInput","type":"object","properties":{"name":{"description":"The Webhook Subscription name","type":"string"},"events":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"type":"array","uniqueItems":true,"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"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..."}}}},"components/schemas/PatchWebhookSubscriptionOutput":{"id":"components/schemas/PatchWebhookSubscriptionOutput","kind":"json-schema","title":"PatchWebhookSubscriptionOutput","data":{"title":"PatchWebhookSubscriptionOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"components/schemas/PeriodFilter":{"id":"components/schemas/PeriodFilter","kind":"json-schema","title":"PeriodFilter","data":{"title":"PeriodFilter","oneOf":[{"$ref":"#/components/schemas/Interval"},{"$ref":"#/components/schemas/Preset"}]}},"components/schemas/Phone":{"id":"components/schemas/Phone","kind":"json-schema","title":"Phone","data":{"title":"Phone","type":"object","required":["value"],"properties":{"value":{"description":"Phone number in E.164 format","type":"string"}}}},"components/schemas/PhoneAttributes":{"id":"components/schemas/PhoneAttributes","kind":"json-schema","title":"PhoneAttributes","data":{"title":"PhoneAttributes","type":"object","required":["from","to"],"properties":{"from":{"type":"string"},"to":{"type":"string"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"duration":{"type":"integer","format":"int32"}}}},"components/schemas/PresenceDuration":{"id":"components/schemas/PresenceDuration","kind":"json-schema","title":"PresenceDuration","data":{"title":"PresenceDuration","type":"object","required":["value","status"],"properties":{"value":{"type":"number","format":"double"},"status":{"$ref":"#/components/schemas/Status"}}}},"components/schemas/Preset":{"id":"components/schemas/Preset","kind":"json-schema","title":"Preset","data":{"title":"Preset","type":"object","required":["value"],"properties":{"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [PreviousQuarter, ThisWeek, PreviousWeek, Yesterday, Today, ThisMonth, PreviousMonth, ThisQuarter, ThisYear]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/PrimitiveField":{"id":"components/schemas/PrimitiveField","kind":"json-schema","title":"PrimitiveField","data":{"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"}]}},"components/schemas/PstnPhoneConversation":{"id":"components/schemas/PstnPhoneConversation","kind":"json-schema","title":"PstnPhoneConversation","data":{"title":"PstnPhoneConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/Query":{"id":"components/schemas/Query","kind":"json-schema","title":"Query","data":{"title":"Query","type":"object","required":["value"],"properties":{"value":{"type":"string"},"exactMatch":{"type":"boolean"}}}},"components/schemas/Queue":{"id":"components/schemas/Queue","kind":"json-schema","title":"Queue","data":{"title":"Queue","type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"},"queuedAt":{"type":"string","format":"date-time"}}}},"components/schemas/Queue1":{"id":"components/schemas/Queue1","kind":"json-schema","title":"Queue","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AbandonedIgnored]"},"children":[]}]}]}],"type":"string"},"offerTimeout":{"type":"integer","format":"int32"},"offeringAlgorithm":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AgentPriorityOneAtATimeRandom, AllAtOnce, AgentPriorityLongestIdle, AgentPriorityAllAtOnce, LongestIdle, OneAtATimeRandom]"},"children":[]}]}]}],"type":"string"},"memberListType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Default, SkillBased]"},"children":[]}]}]}],"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"}}}},"components/schemas/QueueAvailabilityOutput":{"id":"components/schemas/QueueAvailabilityOutput","kind":"json-schema","title":"QueueAvailabilityOutput","data":{"title":"QueueAvailabilityOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ChannelAvailabilityOutcome"}}}}},"components/schemas/QueueId":{"id":"components/schemas/QueueId","kind":"json-schema","title":"QueueId","data":{"title":"QueueId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldCanHaveSingleValueOrBeEmptyOperator"}}}},"components/schemas/QueueMember":{"id":"components/schemas/QueueMember","kind":"json-schema","title":"QueueMember","data":{"title":"QueueMember","type":"object","required":["agentId"],"properties":{"agentId":{"type":"string"},"priority":{"type":"integer","format":"int32"}}}},"components/schemas/QueueMembersOutput":{"id":"components/schemas/QueueMembersOutput","kind":"json-schema","title":"QueueMembersOutput","data":{"title":"QueueMembersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QueueMember"}}}}},"components/schemas/QueueUsages":{"id":"components/schemas/QueueUsages","kind":"json-schema","title":"QueueUsages","data":{"title":"QueueUsages","type":"object","required":["queueId","usages"],"properties":{"queueId":{"type":"string"},"usages":{"$ref":"#/components/schemas/Map_ConversationChannel_Set_String"}}}},"components/schemas/QueuedConversation":{"id":"components/schemas/QueuedConversation","kind":"json-schema","title":"QueuedConversation","data":{"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"}}}},"components/schemas/QuickResponse":{"id":"components/schemas/QuickResponse","kind":"json-schema","title":"QuickResponse","data":{"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"}}}},"components/schemas/RatingOffer":{"id":"components/schemas/RatingOffer","kind":"json-schema","title":"RatingOffer","data":{"title":"RatingOffer","type":"object","required":["id","userId","agentId","ratingType"],"properties":{"id":{"type":"string"},"userId":{"type":"string"},"agentId":{"type":"string"},"ratingType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Csat, Nps, ThumbsUpOrDown]"},"children":[]}]}]}],"type":"string"},"offeredAt":{"type":"string","format":"date-time"}}}},"components/schemas/RatingResult":{"id":"components/schemas/RatingResult","kind":"json-schema","title":"RatingResult","data":{"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"}}}},"components/schemas/Recurring":{"id":"components/schemas/Recurring","kind":"json-schema","title":"Recurring","data":{"title":"Recurring","type":"object","properties":{"dayOfMonth":{"type":"integer","format":"int32"},"monthOfYear":{"type":"integer","format":"int32"},"holiday":{"type":"string"}}}},"components/schemas/Recurring1":{"id":"components/schemas/Recurring1","kind":"json-schema","title":"Recurring","data":{"title":"Recurring","type":"object","properties":{"dayOfMonth":{"type":"integer","format":"int32"},"monthOfYear":{"type":"integer","format":"int32"},"holiday":{"type":"string"}}}},"components/schemas/RefundCreated":{"id":"components/schemas/RefundCreated","kind":"json-schema","title":"RefundCreated","data":{"title":"RefundCreated","type":"object","required":["orderId","total"],"properties":{"orderId":{"description":"External order ID","type":"string"},"refundId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External refund ID — useful for idempotency on partial refunds"},"children":[]}]}]}],"type":"string"},"total":{"$ref":"#/components/schemas/Money","description":"Total refund amount, inclusive of tax and discounts"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}}}}},"components/schemas/Regular":{"id":"components/schemas/Regular","kind":"json-schema","title":"Regular","data":{"title":"Regular","type":"object","required":["content"],"properties":{"content":{"$ref":"#/components/schemas/Content"}}}},"components/schemas/Regular1":{"id":"components/schemas/Regular1","kind":"json-schema","title":"Regular","data":{"title":"Regular","type":"object"}},"components/schemas/Regular2":{"id":"components/schemas/Regular2","kind":"json-schema","title":"Regular","data":{"title":"Regular","type":"object"}},"components/schemas/ReopenConversationInput":{"id":"components/schemas/ReopenConversationInput","kind":"json-schema","title":"ReopenConversationInput","data":{"title":"ReopenConversationInput","type":"object","properties":{"userId":{"type":"string","format":"uuid"}}}},"components/schemas/Restrictions":{"id":"components/schemas/Restrictions","kind":"json-schema","title":"Restrictions","data":{"title":"Restrictions","type":"object","required":["isRestricted"],"properties":{"isRestricted":{"type":"boolean"},"inheritedRestrictions":{"type":"array","items":{"$ref":"#/components/schemas/InheritedRestriction"}}}}},"components/schemas/ReturnReceived":{"id":"components/schemas/ReturnReceived","kind":"json-schema","title":"ReturnReceived","data":{"title":"ReturnReceived","type":"object","required":["orderId"],"properties":{"orderId":{"description":"External order ID","type":"string"},"returnId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"External return ID — links back to the return request"},"children":[]}]}]}],"type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentLineItem"}}}}},"components/schemas/ReturnRequested":{"id":"components/schemas/ReturnRequested","kind":"json-schema","title":"ReturnRequested","data":{"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"}}}}},"components/schemas/SearchConversationsWithFiltersOutput":{"id":"components/schemas/SearchConversationsWithFiltersOutput","kind":"json-schema","title":"SearchConversationsWithFiltersOutput","data":{"title":"SearchConversationsWithFiltersOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationSearchWithFiltersHit"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/SearchField":{"id":"components/schemas/SearchField","kind":"json-schema","title":"SearchField","data":{"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"}]}},"components/schemas/SearchOutput":{"id":"components/schemas/SearchOutput","kind":"json-schema","title":"SearchOutput","data":{"title":"SearchOutput","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConversationSearchHit"}},"meta":{"$ref":"#/components/schemas/PaginationLinks"}}}},"components/schemas/SearchParametersInput":{"id":"components/schemas/SearchParametersInput","kind":"json-schema","title":"SearchParametersInput","data":{"title":"SearchParametersInput","type":"object","properties":{"query":{"$ref":"#/components/schemas/Query"},"filters":{"$ref":"#/components/schemas/Filters"}}}},"components/schemas/Select":{"id":"components/schemas/Select","kind":"json-schema","title":"Select","data":{"title":"Select","type":"object","properties":{"value":{"type":"array","items":{"type":"string"}}}}},"components/schemas/Select1":{"id":"components/schemas/Select1","kind":"json-schema","title":"Select","data":{"title":"Select","type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/SelectOption"}}}}},"components/schemas/SelectOption":{"id":"components/schemas/SelectOption","kind":"json-schema","title":"SelectOption","data":{"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"}}}},"components/schemas/ServerError":{"id":"components/schemas/ServerError","kind":"json-schema","title":"ServerError","data":{"title":"ServerError","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/ShorterThanOrEqualTo":{"id":"components/schemas/ShorterThanOrEqualTo","kind":"json-schema","title":"ShorterThanOrEqualTo","data":{"title":"ShorterThanOrEqualTo","description":"In milliseconds; for example: '10800000' (3 hours)","type":"object","required":["duration"],"properties":{"duration":{"type":"integer","format":"int64"}}}},"components/schemas/SideConversation":{"id":"components/schemas/SideConversation","kind":"json-schema","title":"SideConversation","data":{"title":"SideConversation","type":"object","required":["parentId"],"properties":{"parentId":{"type":"integer","format":"int64"}}}},"components/schemas/Since":{"id":"components/schemas/Since","kind":"json-schema","title":"Since","data":{"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"}}}},"components/schemas/Sms":{"id":"components/schemas/Sms","kind":"json-schema","title":"Sms","data":{"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"}}}},"components/schemas/SmsAttributes":{"id":"components/schemas/SmsAttributes","kind":"json-schema","title":"SmsAttributes","data":{"title":"SmsAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}},"components/schemas/SmsConversation":{"id":"components/schemas/SmsConversation","kind":"json-schema","title":"SmsConversation","data":{"title":"SmsConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"title":"Status","type":"object","required":["status"],"properties":{"status":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/Status1":{"id":"components/schemas/Status1","kind":"json-schema","title":"Status","data":{"title":"Status","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/StatusOperator"}}}},"components/schemas/StatusOperator":{"id":"components/schemas/StatusOperator","kind":"json-schema","title":"StatusOperator","data":{"title":"StatusOperator","oneOf":[{"$ref":"#/components/schemas/IsNotOneOf4"},{"$ref":"#/components/schemas/IsOneOf4"}]}},"components/schemas/StringField":{"id":"components/schemas/StringField","kind":"json-schema","title":"StringField","data":{"title":"StringField","type":"object","required":["value"],"properties":{"value":{"type":"string"},"label":{"type":"string"}}}},"components/schemas/SubmittedRatingResult":{"id":"components/schemas/SubmittedRatingResult","kind":"json-schema","title":"SubmittedRatingResult","data":{"title":"SubmittedRatingResult","oneOf":[{"$ref":"#/components/schemas/Csat"},{"$ref":"#/components/schemas/Nps"},{"$ref":"#/components/schemas/ThumbsUpOrDown"}]}},"components/schemas/Success":{"id":"components/schemas/Success","kind":"json-schema","title":"Success","data":{"title":"Success","type":"object","required":["channelAvailability"],"properties":{"channelAvailability":{"$ref":"#/components/schemas/ChannelAvailability"}}}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"title":"Tag","type":"object","required":["id","name","state"],"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"color":{"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Active, Inactive]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/TagAddedActivityType":{"id":"components/schemas/TagAddedActivityType","kind":"json-schema","title":"TagAddedActivityType","data":{"title":"TagAddedActivityType","type":"object"}},"components/schemas/TagAddedAttribute":{"id":"components/schemas/TagAddedAttribute","kind":"json-schema","title":"TagAddedAttribute","data":{"title":"TagAddedAttribute","type":"object","required":["tag"],"properties":{"tag":{"type":"string"}}}},"components/schemas/TagConversationInput":{"id":"components/schemas/TagConversationInput","kind":"json-schema","title":"TagConversationInput","data":{"title":"TagConversationInput","type":"object","required":["name"],"properties":{"name":{"type":"string"}}}},"components/schemas/TagId":{"id":"components/schemas/TagId","kind":"json-schema","title":"TagId","data":{"title":"TagId","type":"object","required":["operator"],"properties":{"operator":{"$ref":"#/components/schemas/FieldCanHaveMultipleValuesOrBeEmptyOperator"}}}},"components/schemas/TagRemovedActivityType":{"id":"components/schemas/TagRemovedActivityType","kind":"json-schema","title":"TagRemovedActivityType","data":{"title":"TagRemovedActivityType","type":"object"}},"components/schemas/TagRemovedAttribute":{"id":"components/schemas/TagRemovedAttribute","kind":"json-schema","title":"TagRemovedAttribute","data":{"title":"TagRemovedAttribute","type":"object","required":["tag"],"properties":{"tag":{"type":"string"}}}},"components/schemas/TagsUpdateInput":{"id":"components/schemas/TagsUpdateInput","kind":"json-schema","title":"TagsUpdateInput","data":{"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"}}}}},"components/schemas/Team":{"id":"components/schemas/Team","kind":"json-schema","title":"Team","data":{"title":"Team","type":"object","required":["id"],"properties":{"id":{"type":"string","format":"uuid"}}}},"components/schemas/Team1":{"id":"components/schemas/Team1","kind":"json-schema","title":"Team","data":{"title":"Team","type":"object","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/TeamMember":{"id":"components/schemas/TeamMember","kind":"json-schema","title":"TeamMember","data":{"title":"TeamMember","type":"object","required":["id"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phoneNumber":{"type":"string"}}}},"components/schemas/TelephonyEndpoint":{"id":"components/schemas/TelephonyEndpoint","kind":"json-schema","title":"TelephonyEndpoint","data":{"title":"TelephonyEndpoint","type":"object","required":["number"],"properties":{"number":{"type":"string"},"functionality":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Sms, VoiceInbound, VoiceOutbound]"},"children":[]}]}]}],"type":"string"}},"name":{"type":"string"}}}},"components/schemas/Template":{"id":"components/schemas/Template","kind":"json-schema","title":"Template","data":{"title":"Template","oneOf":[{"$ref":"#/components/schemas/EmailAutoReply"},{"$ref":"#/components/schemas/QuickResponse"}]}},"components/schemas/TemplateInput":{"id":"components/schemas/TemplateInput","kind":"json-schema","title":"TemplateInput","data":{"title":"TemplateInput","type":"object","required":["templateId","templateVariableMap"],"properties":{"templateId":{"type":"string","format":"uuid"},"templateVariableMap":{"$ref":"#/components/schemas/Map_String"}}}},"components/schemas/TemplateTypeInput":{"id":"components/schemas/TemplateTypeInput","kind":"json-schema","title":"TemplateTypeInput","data":{"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"}]}},"components/schemas/Text":{"id":"components/schemas/Text","kind":"json-schema","title":"Text","data":{"title":"Text","type":"object","required":["value"],"properties":{"value":{"type":"string"}}}},"components/schemas/Text1":{"id":"components/schemas/Text1","kind":"json-schema","title":"Text","data":{"title":"Text","type":"object","required":["value"],"properties":{"value":{"type":"string"}}}},"components/schemas/Text2":{"id":"components/schemas/Text2","kind":"json-schema","title":"Text","data":{"title":"Text","type":"object","properties":{"placeholder":{"type":"string"}}}},"components/schemas/Text3":{"id":"components/schemas/Text3","kind":"json-schema","title":"Text","data":{"title":"Text","type":"object","required":["body"],"properties":{"body":{"description":"Template body text; maximum 1024 characters","type":"string"}}}},"components/schemas/ThumbsUpOrDown":{"id":"components/schemas/ThumbsUpOrDown","kind":"json-schema","title":"ThumbsUpOrDown","data":{"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"}}}},"components/schemas/TimeInterval":{"id":"components/schemas/TimeInterval","kind":"json-schema","title":"TimeInterval","data":{"title":"TimeInterval","type":"object","required":["startTime","endTime"],"properties":{"startTime":{"type":"string"},"endTime":{"type":"string"}}}},"components/schemas/TimeInterval1":{"id":"components/schemas/TimeInterval1","kind":"json-schema","title":"TimeInterval","data":{"title":"TimeInterval","type":"object","required":["startTime","endTime"],"properties":{"startTime":{"type":"string"},"endTime":{"type":"string"}}}},"components/schemas/TimestampField":{"id":"components/schemas/TimestampField","kind":"json-schema","title":"TimestampField","data":{"title":"TimestampField","type":"object","required":["name","timestamp"],"properties":{"name":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}}}},"components/schemas/TimestampOperator":{"id":"components/schemas/TimestampOperator","kind":"json-schema","title":"TimestampOperator","data":{"title":"TimestampOperator","oneOf":[{"$ref":"#/components/schemas/Between"},{"$ref":"#/components/schemas/Since"},{"$ref":"#/components/schemas/Until"}]}},"components/schemas/TokenAuth":{"id":"components/schemas/TokenAuth","kind":"json-schema","title":"TokenAuth","data":{"title":"TokenAuth","type":"object","required":["value"],"properties":{"value":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token value. It will be added in the headers of the request as: 'Authorization': 'Bearer <value>'"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/TooLarge":{"id":"components/schemas/TooLarge","kind":"json-schema","title":"TooLarge","data":{"title":"TooLarge","type":"object","required":["file"],"properties":{"file":{"$ref":"#/components/schemas/File"}}}},"components/schemas/TranscriptAttributes":{"id":"components/schemas/TranscriptAttributes","kind":"json-schema","title":"TranscriptAttributes","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"}}}},"components/schemas/TransferConversationInput":{"id":"components/schemas/TransferConversationInput","kind":"json-schema","title":"TransferConversationInput","data":{"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 to originate the transfer of the conversation","type":"string","format":"uuid"}}}},"components/schemas/TransferFailedActivityType":{"id":"components/schemas/TransferFailedActivityType","kind":"json-schema","title":"TransferFailedActivityType","data":{"title":"TransferFailedActivityType","type":"object"}},"components/schemas/TransferInitiatedActivityType":{"id":"components/schemas/TransferInitiatedActivityType","kind":"json-schema","title":"TransferInitiatedActivityType","data":{"title":"TransferInitiatedActivityType","type":"object"}},"components/schemas/TransferSuccessfulActivityType":{"id":"components/schemas/TransferSuccessfulActivityType","kind":"json-schema","title":"TransferSuccessfulActivityType","data":{"title":"TransferSuccessfulActivityType","type":"object"}},"components/schemas/Translation":{"id":"components/schemas/Translation","kind":"json-schema","title":"Translation","data":{"title":"Translation","type":"object","required":["locale","content","isDeactivated"],"properties":{"locale":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Format for locale is {language}-{script}-{country}, e.g. \"en-US\", \"uz-Arab-AF\", \"da\""},"children":[]}]}]}],"type":"string"},"content":{"type":"string"},"isDeactivated":{"type":"boolean"},"subject":{"type":"string"}}}},"components/schemas/Translation1":{"id":"components/schemas/Translation1","kind":"json-schema","title":"Translation","data":{"title":"Translation","type":"object","required":["draft"],"properties":{"draft":{"$ref":"#/components/schemas/ArticleTranslation"},"published":{"$ref":"#/components/schemas/ArticleTranslation"}}}},"components/schemas/TranslationError":{"id":"components/schemas/TranslationError","kind":"json-schema","title":"TranslationError","data":{"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"}}}},"components/schemas/TranslationInput":{"id":"components/schemas/TranslationInput","kind":"json-schema","title":"TranslationInput","data":{"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"}}}},"components/schemas/TranslationInput1":{"id":"components/schemas/TranslationInput1","kind":"json-schema","title":"TranslationInput","data":{"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"}}}},"components/schemas/TranslationList":{"id":"components/schemas/TranslationList","kind":"json-schema","title":"TranslationList","data":{"title":"TranslationList","type":"object","properties":{"draft":{"type":"array","items":{"$ref":"#/components/schemas/ArticleTranslation"}},"published":{"type":"array","items":{"$ref":"#/components/schemas/ArticleTranslation"}}}}},"components/schemas/TranslationTitle":{"id":"components/schemas/TranslationTitle","kind":"json-schema","title":"TranslationTitle","data":{"title":"TranslationTitle","type":"object","required":["languageId","title"],"properties":{"languageId":{"type":"string"},"title":{"type":"string"}}}},"components/schemas/TwitterAttributes":{"id":"components/schemas/TwitterAttributes","kind":"json-schema","title":"TwitterAttributes","data":{"title":"TwitterAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}},"components/schemas/TwitterConversation":{"id":"components/schemas/TwitterConversation","kind":"json-schema","title":"TwitterConversation","data":{"title":"TwitterConversation","type":"object","required":["id","requesterId","channel","createdAt","conversationType"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"conversationType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [DirectMessage, Tweet]"},"children":[]}]}]}],"type":"string"},"contactPointTwitterId":{"type":"string"},"endUserTwitterId":{"type":"string"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/UUIDField":{"id":"components/schemas/UUIDField","kind":"json-schema","title":"UUIDField","data":{"title":"UUIDField","type":"object","required":["value"],"properties":{"value":{"type":"string","format":"uuid"},"label":{"type":"string"}}}},"components/schemas/Unauthorized":{"id":"components/schemas/Unauthorized","kind":"json-schema","title":"Unauthorized","data":{"title":"Unauthorized","type":"object","required":["message"],"properties":{"message":{"type":"string"}}}},"components/schemas/UnexpectedError":{"id":"components/schemas/UnexpectedError","kind":"json-schema","title":"UnexpectedError","data":{"title":"UnexpectedError","type":"object","required":["channel","message"],"properties":{"channel":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/UnknownActivityType":{"id":"components/schemas/UnknownActivityType","kind":"json-schema","title":"UnknownActivityType","data":{"title":"UnknownActivityType","type":"object"}},"components/schemas/UnknownAnonymizationType":{"id":"components/schemas/UnknownAnonymizationType","kind":"json-schema","title":"UnknownAnonymizationType","data":{"title":"UnknownAnonymizationType","type":"object"}},"components/schemas/Until":{"id":"components/schemas/Until","kind":"json-schema","title":"Until","data":{"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"}}}},"components/schemas/UpdateAgentInput":{"id":"components/schemas/UpdateAgentInput","kind":"json-schema","title":"UpdateAgentInput","data":{"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"}}}},"components/schemas/UpdateAgentPresenceChannelInput":{"id":"components/schemas/UpdateAgentPresenceChannelInput","kind":"json-schema","title":"UpdateAgentPresenceChannelInput","data":{"title":"UpdateAgentPresenceChannelInput","type":"object","required":["channel","working"],"properties":{"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Email, InteractiveChat, Messaging, Speak]"},"children":[]}]}]}],"type":"string"},"working":{"type":"boolean"}}}},"components/schemas/UpdateEndUserInput":{"id":"components/schemas/UpdateEndUserInput","kind":"json-schema","title":"UpdateEndUserInput","data":{"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"}}}},"components/schemas/UpdateEndUserOutput":{"id":"components/schemas/UpdateEndUserOutput","kind":"json-schema","title":"UpdateEndUserOutput","data":{"title":"UpdateEndUserOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/EndUser"}}}},"components/schemas/UpdateKnowledgeArticleInput":{"id":"components/schemas/UpdateKnowledgeArticleInput","kind":"json-schema","title":"UpdateKnowledgeArticleInput","data":{"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"}}}},"components/schemas/UpdateKnowledgeArticleOutput":{"id":"components/schemas/UpdateKnowledgeArticleOutput","kind":"json-schema","title":"UpdateKnowledgeArticleOutput","data":{"title":"UpdateKnowledgeArticleOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/Article","description":"The updated article"}}}},"components/schemas/UpdateTranslationsInput":{"id":"components/schemas/UpdateTranslationsInput","kind":"json-schema","title":"UpdateTranslationsInput","data":{"title":"UpdateTranslationsInput","type":"object","properties":{"translations":{"description":"List of translations to create or update","type":"array","items":{"$ref":"#/components/schemas/TranslationInput1"}}}}},"components/schemas/UpdateTranslationsOutput":{"id":"components/schemas/UpdateTranslationsOutput","kind":"json-schema","title":"UpdateTranslationsOutput","data":{"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"}}}}},"components/schemas/UploadAttachmentsInput":{"id":"components/schemas/UploadAttachmentsInput","kind":"json-schema","title":"UploadAttachmentsInput","data":{"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"}}}}},"components/schemas/UploadAttachmentsOutput":{"id":"components/schemas/UploadAttachmentsOutput","kind":"json-schema","title":"UploadAttachmentsOutput","data":{"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"}}}}},"components/schemas/UserAnonymizationType":{"id":"components/schemas/UserAnonymizationType","kind":"json-schema","title":"UserAnonymizationType","data":{"title":"UserAnonymizationType","type":"object"}},"components/schemas/UserPresence":{"id":"components/schemas/UserPresence","kind":"json-schema","title":"UserPresence","data":{"title":"UserPresence","type":"object","required":["userId","requestTime","connectionStatus"],"properties":{"userId":{"type":"string"},"requestTime":{"type":"string"},"lastSeen":{"type":"string"},"presenceStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Away, Working]"},"children":[]}]}]}],"type":"string"},"connectionStatus":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Offline, Online]"},"children":[]}]}]}],"type":"string"},"activeChannels":{"type":"array","items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"}}}}},"components/schemas/UserPresenceOutput":{"id":"components/schemas/UserPresenceOutput","kind":"json-schema","title":"UserPresenceOutput","data":{"title":"UserPresenceOutput","type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UserPresence"}}}},"components/schemas/UserReference":{"id":"components/schemas/UserReference","kind":"json-schema","title":"UserReference","data":{"title":"UserReference","oneOf":[{"$ref":"#/components/schemas/ByContactPoints"},{"$ref":"#/components/schemas/ById"}]}},"components/schemas/Validation":{"id":"components/schemas/Validation","kind":"json-schema","title":"Validation","data":{"title":"Validation","type":"object","required":["message"],"properties":{"id":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/WebhookAuthorization":{"id":"components/schemas/WebhookAuthorization","kind":"json-schema","title":"WebhookAuthorization","data":{"title":"WebhookAuthorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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"},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/BasicAuth"},{"$ref":"#/components/schemas/NoAuth"},{"$ref":"#/components/schemas/TokenAuth"}]}},"components/schemas/WebhookSubscription":{"id":"components/schemas/WebhookSubscription","kind":"json-schema","title":"WebhookSubscription","data":{"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":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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]"},"children":[]}]}]}],"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"}}}},"components/schemas/Webhook_Headers_Map_String_String":{"id":"components/schemas/Webhook_Headers_Map_String_String","kind":"json-schema","title":"Webhook_Headers_Map_String_String","data":{"title":"Webhook_Headers_Map_String_String","description":"The headers that will be added to the webhook request","type":"object","additionalProperties":{"type":"string"}}},"components/schemas/WhatsAppAttributes":{"id":"components/schemas/WhatsAppAttributes","kind":"json-schema","title":"WhatsAppAttributes","data":{"title":"WhatsAppAttributes","type":"object","properties":{"content":{"$ref":"#/components/schemas/Content"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/File"}}}}},"components/schemas/WhatsAppConversation":{"id":"components/schemas/WhatsAppConversation","kind":"json-schema","title":"WhatsAppConversation","data":{"title":"WhatsAppConversation","type":"object","required":["id","requesterId","channel","createdAt"],"properties":{"id":{"type":"integer","format":"int64"},"requesterId":{"type":"string","format":"uuid"},"channel":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]"},"children":[]}]}]}],"type":"string"},"createdAt":{"type":"string","format":"date-time"},"direction":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [Inbound, Internal, Outbound]"},"children":[]}]}]}],"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"values: [AwaitingPending, Closed, Open, Pending]"},"children":[]}]}]}],"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"}}}},"components/schemas/Whatsapp":{"id":"components/schemas/Whatsapp","kind":"json-schema","title":"Whatsapp","data":{"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"}}}},"components/schemas/WhatsappOutboundMessage":{"id":"components/schemas/WhatsappOutboundMessage","kind":"json-schema","title":"WhatsappOutboundMessage","data":{"title":"WhatsappOutboundMessage","type":"object","required":["agentId","template"],"properties":{"agentId":{"type":"string","format":"uuid"},"template":{"$ref":"#/components/schemas/TemplateInput"}}}},"components/schemas/WhatsappTemplate":{"id":"components/schemas/WhatsappTemplate","kind":"json-schema","title":"WhatsappTemplate","data":{"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"}}}},"components/schemas/WhatsappTemplateListItem":{"id":"components/schemas/WhatsappTemplateListItem","kind":"json-schema","title":"WhatsappTemplateListItem","data":{"title":"WhatsappTemplateListItem","type":"object","required":["id","name","language","createdAt"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"language":{"type":"string"},"createdAt":{"type":"string"}}}},"schema_74":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/UserPresence"}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateAgentInput"}},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BulkPatchAgentInput"}},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"default":false,"type":"boolean"},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"string","enum":["EmailAutoReply","QuickResponse"]},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"default":7,"type":"integer","format":"int32","minimum":1,"maximum":90},"id":"schema_86"}},"exampleStore":{"paths/~1beta~1analytics~1metrics/get/responses/200/content/application~1json/example":{"value":{"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"]}]},"id":"paths/~1beta~1analytics~1metrics/get/responses/200/content/application~1json/example"},"paths/~1beta~1analytics~1metrics/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1metrics/get/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1metrics/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1metrics/get/responses/500/content/application~1json/example"},"paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0":{"value":{"id":"closed_conversations","periodFilter":{"value":{"_type":"PreviousWeek"},"_type":"Preset"},"filters":[{"attribute":"channel","values":["email"]}],"aggregations":["Count"],"timezone":"Europe/Copenhagen"},"key":"Example0","summary":"Example0","id":"paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example0"},"paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1":{"value":{"id":"closed_conversations","csidFilter":[42,43,44],"filters":[{"attribute":"channel","values":["email"]}],"aggregations":["Count"],"timezone":"Europe/Copenhagen"},"key":"Example1","summary":"Example1","id":"paths/~1beta~1analytics~1metrics/post/requestBody/content/application~1json/examples/Example1"},"paths/~1beta~1analytics~1metrics/post/responses/200/content/application~1json/example":{"value":{"data":{"id":"closed_conversations","aggregates":[{"value":42,"measure":"Count","_type":"LongAggregateValue"}]}},"id":"paths/~1beta~1analytics~1metrics/post/responses/200/content/application~1json/example"},"paths/~1beta~1analytics~1metrics/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1metrics/post/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1metrics/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1metrics/post/responses/500/content/application~1json/example"},"paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/200/content/application~1json/example":{"value":{"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":"paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1metrics~1{metricId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/200/content/application~1json/example":{"value":{"data":[{"value":"CALLBACK","label":"Callback"},{"value":"CONTACT_FORM","label":"Contact Form"}]},"id":"paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/200/content/application~1json/example"},"paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1filter~1{filterAttribute}/get/responses/500/content/application~1json/example"},"paths/~1beta~1analytics~1records/get/responses/200/content/application~1json/example":{"value":{"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}]}]},"id":"paths/~1beta~1analytics~1records/get/responses/200/content/application~1json/example"},"paths/~1beta~1analytics~1records/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1records/get/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1records/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1records/get/responses/500/content/application~1json/example"},"paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0":{"value":{"id":"closed_conversations","periodFilter":{"value":{"_type":"PreviousWeek"},"_type":"Preset"},"filters":[{"attribute":"initial_direction","values":["INBOUND"]}],"timezone":"Europe/Copenhagen"},"key":"Example0","summary":"Example0","id":"paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example0"},"paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1":{"value":{"id":"closed_conversations","csidFilter":[42,43,44],"filters":[{"attribute":"initial_direction","values":["INBOUND"]}],"timezone":"Europe/Copenhagen"},"key":"Example1","summary":"Example1","id":"paths/~1beta~1analytics~1records/post/requestBody/content/application~1json/examples/Example1"},"paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/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"}}]}]},"key":"No Value Metric Records Data Example","summary":"No Value Metric Records Data Example","id":"paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/No Value Metric Records Data Example"},"paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/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"}}]}]},"key":"Metric Records Data Example","summary":"Metric Records Data Example","id":"paths/~1beta~1analytics~1records/post/responses/200/content/application~1json/examples/Metric Records Data Example"},"paths/~1beta~1analytics~1records/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1records/post/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1records/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1records/post/responses/500/content/application~1json/example"},"paths/~1beta~1analytics~1records~1{recordId}/get/responses/200/content/application~1json/example":{"value":{"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":"paths/~1beta~1analytics~1records~1{recordId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1analytics~1records~1{recordId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1analytics~1records~1{recordId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1analytics~1records~1{recordId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1analytics~1records~1{recordId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1presence/get/responses/200/content/application~1json/example":{"value":[{"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"]}],"id":"paths/~1beta~1agents~1presence/get/responses/200/content/application~1json/example"},"paths/~1beta~1agents~1presence/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents~1presence/get/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1presence/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1presence/get/responses/500/content/application~1json/example"},"paths/~1beta~1agents/get/responses/200/content/application~1json/example":{"value":{"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"]}]},"id":"paths/~1beta~1agents/get/responses/200/content/application~1json/example"},"paths/~1beta~1agents/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1agents/get/responses/400/content/application~1json/example"},"paths/~1beta~1agents/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents/get/responses/404/content/application~1json/example"},"paths/~1beta~1agents/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents/get/responses/500/content/application~1json/example"},"paths/~1beta~1agents/put/requestBody/content/application~1json/example":{"value":[{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","displayName":"Alice Brown","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"}],"id":"paths/~1beta~1agents/put/requestBody/content/application~1json/example"},"paths/~1beta~1agents/put/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1agents/put/responses/200/content/application~1json/example"},"paths/~1beta~1agents/put/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents/put/responses/400/content/application~1json/example"},"paths/~1beta~1agents/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents/put/responses/500/content/application~1json/example"},"paths/~1beta~1agents/post/requestBody/content/application~1json/example":{"value":{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":["alice@secondary.email"],"additionalPhoneNumbers":["+5566778899"],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"},"id":"paths/~1beta~1agents/post/requestBody/content/application~1json/example"},"paths/~1beta~1agents/post/responses/201/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1agents/post/responses/201/content/application~1json/example"},"paths/~1beta~1agents/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1agents/post/responses/400/content/application~1json/example"},"paths/~1beta~1agents/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents/post/responses/500/content/application~1json/example"},"paths/~1beta~1agents/patch/requestBody/content/application~1json/example":{"value":[{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9b","displayName":"AB","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[]},{"id":"434ce9f5-14c8-4be1-a0a8-f755010deb9c","displayName":"JB","additionalEmails":[],"additionalPhoneNumbers":[],"middleNames":[]}],"id":"paths/~1beta~1agents/patch/requestBody/content/application~1json/example"},"paths/~1beta~1agents/patch/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1agents/patch/responses/200/content/application~1json/example"},"paths/~1beta~1agents/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents/patch/responses/400/content/application~1json/example"},"paths/~1beta~1agents/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents/patch/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1teams/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"e8ecd53b-2f6c-4471-a3a0-34d94caff8c8"},{"id":"4d2ab456-8510-4a35-b266-e502160d5177"}]},"id":"paths/~1beta~1agents~1{agentId}~1teams/get/responses/200/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1teams/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents~1{agentId}~1teams/get/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1teams/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents~1{agentId}~1teams/get/responses/404/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1teams/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1{agentId}~1teams/get/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence/get/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1agents~1{agentId}~1presence/get/responses/200/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents~1{agentId}~1presence/get/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents~1{agentId}~1presence/get/responses/404/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1{agentId}~1presence/get/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example":{"value":{"data":[{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"}]},"id":"paths/~1beta~1agents~1bulk/post/requestBody/content/application~1json/example"},"paths/~1beta~1agents~1bulk/post/responses/201/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1agents~1bulk/post/responses/201/content/application~1json/example"},"paths/~1beta~1agents~1bulk/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents~1bulk/post/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1bulk/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1bulk/post/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/get/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1agents~1{agentId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1agents~1{agentId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents~1{agentId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1{agentId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example":{"value":{"displayName":"Alice Brown","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":["Julia"],"avatarUrl":"http://avatar.url"},"id":"paths/~1beta~1agents~1{agentId}/put/requestBody/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/put/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1agents~1{agentId}/put/responses/200/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1agents~1{agentId}/put/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents~1{agentId}/put/responses/404/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1{agentId}/put/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1agents~1{agentId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents~1{agentId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example":{"value":{"displayName":"Alice Brown","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url"},"id":"paths/~1beta~1agents~1{agentId}/patch/requestBody/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/patch/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1agents~1{agentId}/patch/responses/200/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1agents~1{agentId}/patch/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1agents~1{agentId}/patch/responses/404/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1{agentId}/patch/responses/500/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example":{"value":{"channel":"Speak","working":false},"id":"paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/requestBody/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/400/content/application~1json/example"},"paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1agents~1{agentId}~1presence~1working-channel/put/responses/500/content/application~1json/example"},"paths/~1beta~1ai-agents/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1ai-agents/get/responses/200/content/application~1json/example"},"paths/~1beta~1ai-agents/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1ai-agents/get/responses/400/content/application~1json/example"},"paths/~1beta~1ai-agents/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1ai-agents/get/responses/500/content/application~1json/example"},"paths/~1beta~1endusers/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers/get/responses/200/content/application~1json/example"},"paths/~1beta~1endusers/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1endusers/get/responses/400/content/application~1json/example"},"paths/~1beta~1endusers/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1endusers/get/responses/404/content/application~1json/example"},"paths/~1beta~1endusers/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers/get/responses/500/content/application~1json/example"},"paths/~1beta~1endusers/put/requestBody/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers/put/requestBody/content/application~1json/example"},"paths/~1beta~1endusers/put/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers/put/responses/200/content/application~1json/example"},"paths/~1beta~1endusers/put/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1endusers/put/responses/400/content/application~1json/example"},"paths/~1beta~1endusers/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers/put/responses/500/content/application~1json/example"},"paths/~1beta~1endusers/post/requestBody/content/application~1json/example":{"value":{"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"},"id":"paths/~1beta~1endusers/post/requestBody/content/application~1json/example"},"paths/~1beta~1endusers/post/responses/201/content/application~1json/example":{"value":{"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"}]}},"id":"paths/~1beta~1endusers/post/responses/201/content/application~1json/example"},"paths/~1beta~1endusers/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1endusers/post/responses/400/content/application~1json/example"},"paths/~1beta~1endusers/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers/post/responses/500/content/application~1json/example"},"paths/~1beta~1endusers/patch/requestBody/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers/patch/requestBody/content/application~1json/example"},"paths/~1beta~1endusers/patch/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers/patch/responses/200/content/application~1json/example"},"paths/~1beta~1endusers/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1endusers/patch/responses/400/content/application~1json/example"},"paths/~1beta~1endusers/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers/patch/responses/500/content/application~1json/example"},"paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example":{"value":{"data":[{"displayName":"Alice Brown","email":"alice@brown.com","phoneNumber":"+551155256325","additionalEmails":[],"additionalPhoneNumbers":[],"firstName":"Alice","lastName":"Brown","middleNames":[],"avatarUrl":"http://avatar.url","externalId":"#12345678"}]},"id":"paths/~1beta~1endusers~1bulk/post/requestBody/content/application~1json/example"},"paths/~1beta~1endusers~1bulk/post/responses/201/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers~1bulk/post/responses/201/content/application~1json/example"},"paths/~1beta~1endusers~1bulk/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1endusers~1bulk/post/responses/400/content/application~1json/example"},"paths/~1beta~1endusers~1bulk/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers~1bulk/post/responses/500/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example":{"value":{"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"}]}},"id":"paths/~1beta~1endusers~1{userId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1endusers~1{userId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1endusers~1{userId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers~1{userId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example":{"value":{"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"},"id":"paths/~1beta~1endusers~1{userId}/put/requestBody/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/put/responses/200/content/application~1json/example":{"value":{"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"}]}},"id":"paths/~1beta~1endusers~1{userId}/put/responses/200/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1endusers~1{userId}/put/responses/400/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1endusers~1{userId}/put/responses/404/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers~1{userId}/put/responses/500/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example":{"value":{"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"},"id":"paths/~1beta~1endusers~1{userId}/patch/requestBody/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/patch/responses/200/content/application~1json/example":{"value":{"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"}]}},"id":"paths/~1beta~1endusers~1{userId}/patch/responses/200/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1endusers~1{userId}/patch/responses/400/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1endusers~1{userId}/patch/responses/404/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers~1{userId}/patch/responses/500/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1endusers~1{userId}~1anonymize/patch/responses/202/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example":{"value":{"274e5a2c-be0d-42c0-b725-3dd533729f68":"abcdef","befae0d9-9679-42b9-af76-e76f64e28429":["example1","example2"]},"id":"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/requestBody/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example":{"value":{"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"]}]},"id":"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/200/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/400/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example":{"value":{"message":"User is unauthorized to perform an underlying operation"},"id":"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/401/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1endusers~1{userId}~1custom-attributes/patch/responses/404/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/200/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/400/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/404/content/application~1json/example"},"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1endusers~1{userId}~1conversations/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example":{"value":{"userId":"5a556159-9c21-4f3e-a44f-d323deb80d16"},"id":"paths/~1beta~1conversations~1{conversationId}~1close/put/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1close/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1close/put/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example":{"value":{"timestamp":"2025-01-08T08:31:25Z","userId":"5a556159-9c21-4f3e-a44f-d323deb80d16"},"id":"paths/~1beta~1conversations~1{conversationId}~1followup/put/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1followup/put/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example":{"value":{"queueId":"92f8d193-b26f-4a62-86a3-bb03ee0915e9","userId":"a53b25da-f676-4c52-acac-58c9280aa23d"},"id":"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1transfer~1queue/put/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example":{"value":{"userId":"d3cf6f15-1497-4e71-92f2-9b3b228352bd","ratingResult":{"value":4,"_type":"Csat"},"comment":"Best customer service ever!","submittedAt":"2024-03-11T16:39:30Z"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/201/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1{ratingId}~1submit/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example":{"value":{"userId":"b0323b42-c428-4afa-970e-20bf5bdeeec4","agentId":"eeb3bbe5-0355-4ac1-8af5-20d42a3db24b","ratingType":"Csat","offeredAt":"2024-03-11T16:39:30Z"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/201/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings~1offer/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/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"},"key":"Email","summary":"Email","id":"paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/Email"},"paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/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"},"key":"WhatsApp","summary":"WhatsApp","id":"paths/~1beta~1conversations/post/requestBody/content/application~1json/examples/WhatsApp"},"paths/~1beta~1conversations/post/responses/201/content/application~1json/example":{"value":{"data":{"id":100}},"id":"paths/~1beta~1conversations/post/responses/201/content/application~1json/example"},"paths/~1beta~1conversations/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example":{"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"},"key":"Generic API messaging conversation example","summary":"Generic API messaging conversation example","id":"paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Generic API messaging conversation example"},"paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example":{"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"},"key":"Email conversation example","summary":"Email conversation example","id":"paths/~1beta~1conversations~1import/post/requestBody/content/application~1json/examples/Email conversation example"},"paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example":{"value":{"data":{"id":100,"partialErrors":[{"message":"The conversation could not be assigned"},{"message":"Invalid attachment url in message. externalId: 42"}]}},"id":"paths/~1beta~1conversations~1import/post/responses/201/content/application~1json/example"},"paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1import/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1import/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1import/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example":{"value":{"agentId":"5a556159-9c21-4f3e-a44f-d323deb80d16","force":false},"id":"paths/~1beta~1conversations~1{conversationId}~1claim/put/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1claim/put/responses/404/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1queues~1{queueId}~1availability/get/responses/200/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1queues~1{queueId}~1availability/get/responses/400/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues~1{queueId}~1availability/get/responses/500/content/application~1json/example"},"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example":{"value":{"data":{"position":10,"queuedAt":"2021-12-01T13:00:00.003Z"}},"id":"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/200/content/application~1json/example"},"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/400/content/application~1json/example"},"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/404/content/application~1json/example"},"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues~1conversation-position~1{csid}/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/202/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1anonymize/patch/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/202/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1messages~1{messageId}~1anonymize/patch/responses/400/content/application~1json/example"},"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/200/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/401/content/application~1json/example":{"value":{"message":"User is unauthorized to perform an underlying operation"},"id":"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/401/content/application~1json/example"},"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1anonymization~1request~1{requestId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1anonymization/post/requestBody/content/application~1json/example":{"value":{"entityId":"a53b25da-f676-4c52-acac-58c9280aa23d","_type":"User"},"id":"paths/~1beta~1anonymization/post/requestBody/content/application~1json/example"},"paths/~1beta~1anonymization/post/responses/200/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1anonymization/post/responses/200/content/application~1json/example"},"paths/~1beta~1anonymization/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1anonymization/post/responses/400/content/application~1json/example"},"paths/~1beta~1anonymization/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1anonymization/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example":{"value":{"2f5515b6-7e98-4f4d-9010-bfd2a27d4f35":"012345","e14708a6-eed9-495c-9d88-c72331e9e247":["str1","str2"]},"id":"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example":{"value":{"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"]}]},"id":"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example":{"value":{"message":"User is unauthorized to perform an underlying operation"},"id":"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/401/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1custom-attributes/patch/responses/404/content/application~1json/example"},"paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/200/content/application~1json/example":{"value":{"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}},"id":"paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1custom-attributes~1{customAttributeId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1custom-attributes/get/responses/200/content/application~1json/example":{"value":{"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}]},"id":"paths/~1beta~1custom-attributes/get/responses/200/content/application~1json/example"},"paths/~1beta~1custom-attributes/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1custom-attributes/get/responses/400/content/application~1json/example"},"paths/~1beta~1custom-attributes/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1custom-attributes/get/responses/500/content/application~1json/example"},"paths/~1beta~1teams/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"005e7108-c85c-41d1-a945-4a8dc58c4399","name":"Team A"},{"id":"83cc3c21-9d28-4250-b6ea-b3a6333c5c73","name":"Team B"}]},"id":"paths/~1beta~1teams/get/responses/200/content/application~1json/example"},"paths/~1beta~1teams/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams/get/responses/400/content/application~1json/example"},"paths/~1beta~1teams/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams/get/responses/500/content/application~1json/example"},"paths/~1beta~1teams/post/requestBody/content/application~1json/example":{"value":{"name":"Team A"},"id":"paths/~1beta~1teams/post/requestBody/content/application~1json/example"},"paths/~1beta~1teams/post/responses/201/content/application~1json/example":{"value":{"data":{"id":"005e7108-c85c-41d1-a945-4a8dc58c4399","name":"Team A"}},"id":"paths/~1beta~1teams/post/responses/201/content/application~1json/example"},"paths/~1beta~1teams/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams/post/responses/400/content/application~1json/example"},"paths/~1beta~1teams/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams/post/responses/500/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1teams~1{teamId}~1agents/get/responses/200/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams~1{teamId}~1agents/get/responses/400/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams~1{teamId}~1agents/get/responses/500/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example":{"value":{"agentIds":["a8080cf3-9d55-41dd-a8ef-b02414399e7a","d53dbec1-e79c-4736-b9a1-15f6dce71ed4"]},"id":"paths/~1beta~1teams~1{teamId}~1agents/delete/requestBody/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams~1{teamId}~1agents/delete/responses/400/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams~1{teamId}~1agents/delete/responses/500/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example":{"value":{"agentIds":["912d5148-6918-4420-b23a-8584b896c8ae","a8080cf3-9d55-41dd-a8ef-b02414399e7a"]},"id":"paths/~1beta~1teams~1{teamId}~1agents/patch/requestBody/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams~1{teamId}~1agents/patch/responses/400/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1agents/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams~1{teamId}~1agents/patch/responses/500/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1presence/get/responses/200/content/application~1json/example":{"value":{"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"]}]},"id":"paths/~1beta~1teams~1{teamId}~1presence/get/responses/200/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1presence/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams~1{teamId}~1presence/get/responses/400/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1presence/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1teams~1{teamId}~1presence/get/responses/404/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}~1presence/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams~1{teamId}~1presence/get/responses/500/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}/get/responses/200/content/application~1json/example":{"value":{"data":{"id":"005e7108-c85c-41d1-a945-4a8dc58c4399","name":"Team A"}},"id":"paths/~1beta~1teams~1{teamId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams~1{teamId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1teams~1{teamId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1teams~1{teamId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1teams~1{teamId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1teams~1{teamId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example":{"value":{"userId":"a53b25da-f676-4c52-acac-58c9280aa23d"},"id":"paths/~1beta~1conversations~1{conversationId}~1reopen/put/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1reopen/put/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/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"}]},"key":"Input with two internal notes created for the same conversation","summary":"Input with two internal notes created for the same conversation","id":"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/requestBody/content/application~1json/examples/Input with two internal notes created for the same conversation"},"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/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"}]},"key":"A list of internal notes created successfully and error message for others which failed","summary":"A list of internal notes created successfully and error message for others which failed","id":"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/200/content/application~1json/examples/A list of internal notes created successfully and error message for others which failed"},"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes~1bulk/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt":{"value":{"message":"A sample note","agentId":"a53b25da-f676-4c52-acac-58c9280aa23d","createdAt":"2021-12-01T12:46:36.581Z[GMT]"},"key":"Input with createdAt","summary":"Input with createdAt","id":"paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input with createdAt"},"paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt":{"value":{"message":"Another sample note"},"key":"Input without createdAt","summary":"Input without createdAt","id":"paths/~1beta~1conversations~1{conversationId}~1notes/post/requestBody/content/application~1json/examples/Input without createdAt"},"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/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"}},"key":"created internal note","summary":"created internal note","id":"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/200/content/application~1json/examples/created internal note"},"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1notes/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/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"}}]},"key":"Response when a single question (CSAT) survey was offered","summary":"Response when a single question (CSAT) survey was offered","id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a single question (CSAT) survey was offered"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/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"}}]},"key":"Response when a multiple question survey was offered","summary":"Response when a multiple question survey was offered","id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was offered"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/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"}}]},"key":"Response when a multiple question survey was answered","summary":"Response when a multiple question survey was answered","id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was answered"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/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"}}]},"key":"Response when a multiple question survey was partially answered","summary":"Response when a multiple question survey was partially answered","id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when a multiple question survey was partially answered"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/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"}}]},"key":"Response when offer and score was submitted via Dev API","summary":"Response when offer and score was submitted via Dev API","id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/200/content/application~1json/examples/Response when offer and score was submitted via Dev API"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1ratings/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1activitylog/get/responses/200/content/application~1json/example":{"value":{"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"}}]},"id":"paths/~1beta~1conversations~1activitylog/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1activitylog/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1activitylog/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1activitylog/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1activitylog/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1flows/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":"d546e9a8-82c2-409f-b688-e9199ea69f83","name":"Default call flow","channel":"PstnPhone","contactEndpointId":"+559912443333"}]},"id":"paths/~1beta~1conversations~1flows/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1flows/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1flows/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1flows/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1flows/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/put/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1{tagId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example":{"value":{"data":[{"name":"Example #1"},{"name":"Example #2"}]},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags~1bulk/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example":{"value":{"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":"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1tags/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/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"}}]},"key":"Email messages example (Regular and TooLarge content)","summary":"Email messages example (Regular and TooLarge content)","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Email messages example (Regular and TooLarge content)"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Chat message example","summary":"Chat message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Chat message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Contact form message example","summary":"Contact form message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Contact form message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Messenger form message example","summary":"Messenger form message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Messenger form message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Phone message example","summary":"Phone message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Phone message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Call recording message example","summary":"Call recording message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Call recording message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"SMS message example","summary":"SMS message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/SMS message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Facebook Messenger message example","summary":"Facebook Messenger message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Facebook Messenger message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"WhatsApp message example","summary":"WhatsApp message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/WhatsApp message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/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"}}]},"key":"Generic message example","summary":"Generic message example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/200/content/application~1json/examples/Generic message example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1messages/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example":{"value":{"content":{"value":"I need some help!","_type":"Html"},"attachments":[{"url":"http://attachment.url","prettyName":"Filename"}],"_type":"Inbound"},"key":"General inbound example","summary":"General inbound example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General inbound example"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/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"},"key":"General outbound example","summary":"General outbound example","id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/General outbound example"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/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"},"key":"Whatsapp outbound","summary":"Whatsapp outbound","id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/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"},"key":"Whatsapp outbound with attachments","summary":"Whatsapp outbound with attachments","id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/requestBody/content/application~1json/examples/Whatsapp outbound with attachments"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1messages/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/200/content/application~1json/example":{"value":{"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"}}]},"id":"paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1activitylog/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}/get/responses/200/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1conversations~1{conversationId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example":{"value":{"parentId":12345,"linkType":"SideConversation"},"id":"paths/~1beta~1conversations~1{conversationId}~1link/put/requestBody/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1link/put/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1link/put/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1link/put/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1link/put/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1link/put/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1link/put/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1linked/get/responses/500/content/application~1json/example"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/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"}}]}},"key":"Find conversations that include one of two tags","summary":"Find conversations that include one of two tags","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that include one of two tags"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags":{"value":{"query":{"value":"order 12345","exactMatch":true},"filters":{"strategy":"All","conditions":[{"field":{"operator":{"_type":"IsNotEmpty"},"_type":"TagId"}}]}},"key":"Find conversations that contain any tags","summary":"Find conversations that contain any tags","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain any tags"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations that contain all specified tags and contains specific text","summary":"Find conversations that contain all specified tags and contains specific text","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations that contain all specified tags and contains specific text"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations with custom attribute of type Text","summary":"Find conversations with custom attribute of type Text","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Text"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations with custom attribute of type Select","summary":"Find conversations with custom attribute of type Select","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with custom attribute of type Select"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations where custom attribute is not set","summary":"Find conversations where custom attribute is not set","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations where custom attribute is not set"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds":{"value":{"filters":{"strategy":"All","conditions":[{"field":{"operator":{"min":10000,"max":20000,"_type":"Between"},"_type":"Duration"}}]}},"key":"Find conversations with duration between 10 and 20 seconds","summary":"Find conversations with duration between 10 and 20 seconds","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with duration between 10 and 20 seconds"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations with last message since specified time","summary":"Find conversations with last message since specified time","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with last message since specified time"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations in a specific queue and with last activity until certain date","summary":"Find conversations in a specific queue and with last activity until certain date","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations in a specific queue and with last activity until certain date"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations with creation date between two timestamps or closed date between two timestamps","summary":"Find conversations with creation date between two timestamps or closed date between two timestamps","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with creation date between two timestamps or closed date between two timestamps"},"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/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"}}]}},"key":"Find conversations with direction Inbound and channel Phone or SMS","summary":"Find conversations with direction Inbound and channel Phone or SMS","id":"paths/~1beta~1search~1conversations/post/requestBody/content/application~1json/examples/Find conversations with direction Inbound and channel Phone or SMS"},"paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/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:"}},"key":"Results when query was not provided and next page is available","summary":"Results when query was not provided and next page is available","id":"paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was not provided and next page is available"},"paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/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>"]}}]},"key":"Results when query was provided and no more pages are available","summary":"Results when query was provided and no more pages are available","id":"paths/~1beta~1search~1conversations/post/responses/200/content/application~1json/examples/Results when query was provided and no more pages are available"},"paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1search~1conversations/post/responses/400/content/application~1json/example"},"paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example":{"value":{"message":"User is unauthorized to perform an underlying operation"},"id":"paths/~1beta~1search~1conversations/post/responses/401/content/application~1json/example"},"paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1search~1conversations/post/responses/500/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example":{"value":{"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":{}}]},"id":"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/200/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/400/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/404/content/application~1json/example"},"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1conversations~1{conversationId}~1rating/get/responses/500/content/application~1json/example"},"paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example":{"value":{"data":[{"id":1234,"highlights":{"subject":["<em class=\"highlight\">Cancel my order</em>"]},"innerHits":[]}]},"id":"paths/~1beta~1search~1conversations/get/responses/200/content/application~1json/example"},"paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1search~1conversations/get/responses/400/content/application~1json/example"},"paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example":{"value":{"message":"User is unauthorized to perform an underlying operation"},"id":"paths/~1beta~1search~1conversations/get/responses/401/content/application~1json/example"},"paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1search~1conversations/get/responses/500/content/application~1json/example"},"paths/~1beta~1tags/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1tags/get/responses/200/content/application~1json/example"},"paths/~1beta~1tags/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1tags/get/responses/400/content/application~1json/example"},"paths/~1beta~1tags/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1tags/get/responses/500/content/application~1json/example"},"paths/~1beta~1tags/post/requestBody/content/application~1json/example":{"value":{"name":"test","color":"#000000"},"id":"paths/~1beta~1tags/post/requestBody/content/application~1json/example"},"paths/~1beta~1tags/post/responses/200/content/application~1json/example":{"value":{"data":{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"}},"id":"paths/~1beta~1tags/post/responses/200/content/application~1json/example"},"paths/~1beta~1tags/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1tags/post/responses/400/content/application~1json/example"},"paths/~1beta~1tags/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1tags/post/responses/500/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/get/responses/200/content/application~1json/example":{"value":{"data":{"id":"b794a74a-625b-4303-8237-9b11668a9605","name":"example","state":"Active"}},"id":"paths/~1beta~1tags~1{tagId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1tags~1{tagId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1tags~1{tagId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1tags~1{tagId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1tags~1{tagId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1tags~1{tagId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1tags~1{tagId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/400/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/404/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1tags~1{tagId}~1deactivate/patch/responses/500/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}~1activate/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1tags~1{tagId}~1activate/patch/responses/400/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}~1activate/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1tags~1{tagId}~1activate/patch/responses/404/content/application~1json/example"},"paths/~1beta~1tags~1{tagId}~1activate/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1tags~1{tagId}~1activate/patch/responses/500/content/application~1json/example"},"paths/~1beta~1queues/get/responses/200/content/application~1json/example":{"value":{"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}]},"id":"paths/~1beta~1queues/get/responses/200/content/application~1json/example"},"paths/~1beta~1queues/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1queues/get/responses/400/content/application~1json/example"},"paths/~1beta~1queues/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues/get/responses/500/content/application~1json/example"},"paths/~1beta~1queues/post/requestBody/content/application~1json/example":{"value":{"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}},"id":"paths/~1beta~1queues/post/requestBody/content/application~1json/example"},"paths/~1beta~1queues/post/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1queues/post/responses/400/content/application~1json/example"},"paths/~1beta~1queues/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues/post/responses/500/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/get/responses/200/content/application~1json/example":{"value":{"data":[{"agentId":"e96647c1-f697-4328-868a-19f828a6ee46","priority":1},{"agentId":"95dfa97e-dbf5-4bfc-be64-1f834baebd4e","priority":2}]},"id":"paths/~1beta~1queues~1{queueId}~1members/get/responses/200/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1queues~1{queueId}~1members/get/responses/400/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1queues~1{queueId}~1members/get/responses/404/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues~1{queueId}~1members/get/responses/500/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example":{"value":{"agentIds":["743c3781-c882-4352-a1fa-fe5d7a673cfd","cad2f234-8cec-4cd8-96e9-a6491a0176da"]},"id":"paths/~1beta~1queues~1{queueId}~1members/delete/requestBody/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1queues~1{queueId}~1members/delete/responses/400/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1queues~1{queueId}~1members/delete/responses/404/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues~1{queueId}~1members/delete/responses/500/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example":{"value":{"agentIds":["c31e5e3f-1d5f-4442-83df-fd7bddd59da4","26ae145b-8644-4fa5-aa56-7b3dcacbe2d4"]},"id":"paths/~1beta~1queues~1{queueId}~1members/patch/requestBody/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/patch/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1queues~1{queueId}~1members/patch/responses/200/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/patch/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1queues~1{queueId}~1members/patch/responses/400/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1queues~1{queueId}~1members/patch/responses/404/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}~1members/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues~1{queueId}~1members/patch/responses/500/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}/get/responses/200/content/application~1json/example":{"value":{"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}},"id":"paths/~1beta~1queues~1{queueId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1queues~1{queueId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1queues~1{queueId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1queues~1{queueId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1queues~1{queueId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/200/content/application~1json/example":{"value":{"data":{"address":"some@email.com","senderOverride":"otheremail@mail.dk","name":"Special email flow","_type":"EmailEndpoint"}},"id":"paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1contact-endpoints~1{contactEndpointId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1contact-endpoints/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1contact-endpoints/get/responses/200/content/application~1json/example"},"paths/~1beta~1contact-endpoints/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1contact-endpoints/get/responses/400/content/application~1json/example"},"paths/~1beta~1contact-endpoints/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1contact-endpoints/get/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/200/content/application~1json/example":{"value":{"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"}}}},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example":{"value":{"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"}}},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/requestBody/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/200/content/application~1json/example":{"value":{"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"}}}},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/200/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}/patch/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks/get/responses/200/content/application~1json/example":{"value":{"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"}}}]},"id":"paths/~1beta~1webhooks/get/responses/200/content/application~1json/example"},"paths/~1beta~1webhooks/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1webhooks/get/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks/get/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks/post/requestBody/content/application~1json/example":{"value":{"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"}}},"id":"paths/~1beta~1webhooks/post/requestBody/content/application~1json/example"},"paths/~1beta~1webhooks/post/responses/201/content/application~1json/example":{"value":{"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"}}}},"id":"paths/~1beta~1webhooks/post/responses/201/content/application~1json/example"},"paths/~1beta~1webhooks/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1webhooks/post/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks/post/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/200/content/application~1json/example":{"value":{"data":[{"event":"ConversationCreated","deliveryStatus":{"deliveryTimestamp":"2023-09-15T12:00:00.000Z","success":true,"responseCode":200,"responseText":"OK","_type":"DeliveryDetail"}},{"event":"ConversationClosed","deliveryStatus":{"_type":"NoRecentDelivery"}}]},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/200/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/404/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status/get/responses/500/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/200/content/application~1json/example":{"value":{"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\" ] } } }"}]},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/200/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/400/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/404/content/application~1json/example"},"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1webhooks~1{webhookSubscriptionId}~1delivery-status~1logs~1{event}/get/responses/500/content/application~1json/example"},"paths/~1beta~1templates/get/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1templates/get/responses/200/content/application~1json/example"},"paths/~1beta~1templates/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1templates/get/responses/400/content/application~1json/example"},"paths/~1beta~1templates/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1templates/get/responses/500/content/application~1json/example"},"paths/~1beta~1templates~1{templateId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1templates~1{templateId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1templates~1{templateId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1templates~1{templateId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1templates~1{templateId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1templates~1{templateId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules/get/responses/200/content/application~1json/example":{"value":{"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"}]}},"id":"paths/~1beta~1business-hours~1schedules/get/responses/200/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1business-hours~1schedules/get/responses/400/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1business-hours~1schedules/get/responses/500/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/200/content/application~1json/example":{"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"},{"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"}]}}},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/200/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/400/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/404/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1definition/get/responses/500/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/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"}]}}},"key":"Days open with a single interval","summary":"Days open with a single interval","id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Days open with a single interval"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/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"}]}}},"key":"Split hours (closed 12:00-13:00) and an explicitly closed day","summary":"Split hours (closed 12:00-13:00) and an explicitly closed day","id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/Split hours (closed 12:00-13:00) and an explicitly closed day"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/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":[]}}},"key":"No day in the requested window has configured hours","summary":"No day in the requested window has configured hours","id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/200/content/application~1json/examples/No day in the requested window has configured hours"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/400/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/404/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1upcoming/get/responses/500/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Open, closes at 17:00":{"value":{"data":{"isOpen":true,"timestamp":"2025-01-08T08:31:25Z","closesAt":"2025-01-08T17:00:00Z"}},"key":"Open, closes at 17:00","summary":"Open, closes at 17:00","id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Open, closes at 17:00"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, next opening at 09:00":{"value":{"data":{"isOpen":false,"timestamp":"2025-01-08T05:31:25Z","opensAt":"2025-01-08T09:00:00Z"}},"key":"Closed, next opening at 09:00","summary":"Closed, next opening at 09:00","id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, next opening at 09:00"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, no opening within the next year":{"value":{"data":{"isOpen":false,"timestamp":"2025-01-08T05:31:25Z"}},"key":"Closed, no opening within the next year","summary":"Closed, no opening within the next year","id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/200/content/application~1json/examples/Closed, no opening within the next year"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/400/content/application~1json/example"},"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1business-hours~1schedules~1{scheduleId}~1status/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/200/content/application~1json/example":{"value":{"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"}]}}},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/200/content/application~1json/example":{"value":{"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"}}]}},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1collections~1{collectionId}~1catalog/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/200/content/application~1json/example":{"value":{"data":{"titles":[{"languageId":"en","title":"Getting Started"}]}},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1categories~1{categoryId}~1translations/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example":{"value":{"ownedBy":"123e4567-e89b-12d3-a456-426614174000","tags":{"add":["tag-id-1"]},"preRelease":false},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/patch/requestBody/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}/patch/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/200/content/application~1json/example":{"value":{"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"}]}}},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example":{"value":{"translations":[{"languageId":"en","title":"My Article","content":"<p>Hello world</p>"}]},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/requestBody/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/200/content/application~1json/example":{"value":{"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"}]},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations/patch/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example":{"value":{"translations":[{"languageId":"en","title":"My Article","content":"<p>Content</p>"}],"parentId":"123e4567-e89b-12d3-a456-426614174000","tags":["f6020a03-5a7a-4d9e-81e6-f1b76a855a5e"],"preRelease":false},"id":"paths/~1beta~1knowledge~1articles/post/requestBody/content/application~1json/example"},"paths/~1beta~1knowledge~1articles/post/responses/200/content/application~1json/example":{"value":{"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"]}},"id":"paths/~1beta~1knowledge~1articles/post/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1articles/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles/post/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles/post/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles/post/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1publish/post/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}~1unpublish/post/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1translations~1{languageId}/delete/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1publish/post/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1unpublish/post/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1parent~1{parentId}/patch/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1{articleId}~1parent/delete/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1collections/get/responses/200/content/application~1json/example":{"value":{"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"}]}}]},"id":"paths/~1beta~1knowledge~1collections/get/responses/200/content/application~1json/example"},"paths/~1beta~1knowledge~1collections/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1collections/get/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1collections/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1knowledge~1collections/get/responses/404/content/application~1json/example"},"paths/~1beta~1knowledge~1collections/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1collections/get/responses/500/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/All succeeded":{"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":[]},"key":"All succeeded","summary":"Every uploaded file was accepted","id":"paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/All succeeded"},"paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/Partial success":{"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}]},"key":"Partial success","summary":"Some files succeeded; others failed validation (400) or upload (500)","id":"paths/~1beta~1knowledge~1articles~1attachments/post/responses/200/content/application~1json/examples/Partial success"},"paths/~1beta~1knowledge~1articles~1attachments/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1knowledge~1articles~1attachments/post/responses/400/content/application~1json/example"},"paths/~1beta~1knowledge~1articles~1attachments/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1knowledge~1articles~1attachments/post/responses/500/content/application~1json/example"},"paths/~1beta~1organization/get/responses/200/content/application~1json/example":{"value":{"data":{"id":"e9609fa9-efff-4fdc-a7ef-dd335f33c5f6","name":"Example Organization","subdomain":"example-org","status":"Active"}},"id":"paths/~1beta~1organization/get/responses/200/content/application~1json/example"},"paths/~1beta~1organization/get/responses/400/content/application~1json/example":{"value":{"message":"Invalid value in request"},"id":"paths/~1beta~1organization/get/responses/400/content/application~1json/example"},"paths/~1beta~1organization/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1organization/get/responses/404/content/application~1json/example"},"paths/~1beta~1organization/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1organization/get/responses/500/content/application~1json/example"},"paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1commerce-events/post/requestBody/content/application~1json/example"},"paths/~1beta~1commerce-events/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1commerce-events/post/responses/400/content/application~1json/example"},"paths/~1beta~1commerce-events/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1commerce-events/post/responses/404/content/application~1json/example"},"paths/~1beta~1commerce-events/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1commerce-events/post/responses/500/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/200/content/application~1json/example":{"value":{"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"}}},"id":"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/200/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/400/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/404/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1whatsapp~1templates~1{templateId}/get/responses/500/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/get/responses/200/content/application~1json/example":{"value":{"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"}},"id":"paths/~1beta~1whatsapp~1templates/get/responses/200/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/get/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1whatsapp~1templates/get/responses/400/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/get/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1whatsapp~1templates/get/responses/500/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template":{"value":{"name":"order_confirmation","language":"en","templateType":{"body":"Your order {{1}} has been confirmed.","_type":"Text"},"category":"UTILITY","variables":{"1":"12345"}},"key":"Text template","summary":"Text template","id":"paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Text template"},"paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/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"}},"key":"Media template","summary":"Media template","id":"paths/~1beta~1whatsapp~1templates/post/requestBody/content/application~1json/examples/Media template"},"paths/~1beta~1whatsapp~1templates/post/responses/201/content/application~1json/example":{"value":{"data":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"id":"paths/~1beta~1whatsapp~1templates/post/responses/201/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/post/responses/400/content/application~1json/example":{"value":{"message":"Decoding failure in request"},"id":"paths/~1beta~1whatsapp~1templates/post/responses/400/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/post/responses/404/content/application~1json/example":{"value":{"message":"The requested resource could not be found"},"id":"paths/~1beta~1whatsapp~1templates/post/responses/404/content/application~1json/example"},"paths/~1beta~1whatsapp~1templates/post/responses/500/content/application~1json/example":{"value":{"message":"There was an internal server error while processing the request"},"id":"paths/~1beta~1whatsapp~1templates/post/responses/500/content/application~1json/example"}},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","in":"header","paramName":"Authorization"}},"servers":[{"url":"https://dev.dixa.io"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi/dixa-api/beta","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/dixa-api/@beta/index.json?download"},{"url":"/_bundle/openapi/dixa-api/@beta/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Dixa API"}},"baseSlug":"/openapi/dixa-api/beta","routesMapping":{}}