{ "info": { "_postman_id": "43b9335f-6898-4d64-8173-4111ea1c8354", "name": "Contact Center Chat Gateway", "description": "Integration with the 8x8 Contact Center (CC) Chat API\n\nContact Support:\n Email: cc-cluj-iris@8x8.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T00:27:05.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "lastUpdatedBy": "35240", "uid": "35240-43b9335f-6898-4d64-8173-4111ea1c8354" }, "item": [ { "name": "chat-gateway", "item": [ { "name": "v1", "item": [ { "name": "webhooks", "item": [ { "name": "{webhookId}", "item": [ { "name": "Get webhook by Id.", "id": "b41db36a-d362-4f33-9b44-1bc32c2725b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "id": "44b95dfa-1e07-4f7e-a80e-5ed6f4feb2fb", "key": "webhookId", "value": "", "description": "(Required) WebHook identifier." } ] }, "description": "Retrieves the webhook by the provided Id." }, "response": [ { "id": "22ffd591-2038-4e31-9337-93b3e33c6349", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-22ffd591-2038-4e31-9337-93b3e33c6349" }, { "id": "f207dd8b-1df2-461f-9a88-7946fdb3e9a3", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f207dd8b-1df2-461f-9a88-7946fdb3e9a3" }, { "id": "4a63b5eb-48eb-4cf3-97bb-6920505ca68f", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4a63b5eb-48eb-4cf3-97bb-6920505ca68f" }, { "id": "fcf07413-ac8e-40ef-9927-4dae5ec9ed57", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-fcf07413-ac8e-40ef-9927-4dae5ec9ed57" }, { "id": "471d5d91-a011-4c2d-ad5e-29e70fe03a8c", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-471d5d91-a011-4c2d-ad5e-29e70fe03a8c" }, { "id": "2f6ef236-f7cb-471c-a3fb-19d53637d4f3", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2f6ef236-f7cb-471c-a3fb-19d53637d4f3" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b41db36a-d362-4f33-9b44-1bc32c2725b2" }, { "name": "Updates the full webhook resource by Id.", "id": "971f1c37-fdd1-4788-9fb2-4d7e99cbdb58", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "id": "64a7312c-1e70-4408-9231-638609f9c5a2", "key": "webhookId", "value": "", "description": "(Required) WebHook identifier." } ] }, "description": "Updates the full webhook resource by Id." }, "response": [ { "id": "57b2722e-8940-4803-8716-e30ea95ebf80", "name": "Webhook successfully updated.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-57b2722e-8940-4803-8716-e30ea95ebf80" }, { "id": "66ed48c8-ed95-4250-ae7c-3835a9902bfd", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-66ed48c8-ed95-4250-ae7c-3835a9902bfd" }, { "id": "d22bcef0-a487-4fb4-9b44-62b8de532d27", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d22bcef0-a487-4fb4-9b44-62b8de532d27" }, { "id": "5e79f2b1-8e59-4e5e-96f9-ed1b18ece97a", "name": "Contains a descriptive response.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5e79f2b1-8e59-4e5e-96f9-ed1b18ece97a" }, { "id": "398ea271-3755-4e1f-9a8f-df614369eeff", "name": "Contains a descriptive information.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-398ea271-3755-4e1f-9a8f-df614369eeff" }, { "id": "289e9367-c048-41e1-8347-561b9cb0ddf5", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-289e9367-c048-41e1-8347-561b9cb0ddf5" }, { "id": "1ce86998-c984-4ac6-96c5-5f8cd86fe2af", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1ce86998-c984-4ac6-96c5-5f8cd86fe2af" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-971f1c37-fdd1-4788-9fb2-4d7e99cbdb58" }, { "name": "Deletes the webhook by Id.", "id": "0be584e2-97c1-4c7f-ab66-c3e3ad278837", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "id": "a0c6eee2-89f1-4e3e-9955-a4271a6ced38", "key": "webhookId", "value": "", "description": "(Required) WebHook identifier." } ] }, "description": "Deletes the webhook by Id." }, "response": [ { "id": "45bb61a7-3588-4125-bbcb-ecc6332e7842", "name": "A deleted resource.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-45bb61a7-3588-4125-bbcb-ecc6332e7842" }, { "id": "14cde0f0-aa45-4529-a0a1-3dc550ba0b9f", "name": "Contains a description of the error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-14cde0f0-aa45-4529-a0a1-3dc550ba0b9f" }, { "id": "5391f8ce-ea8d-4d3e-94f8-c99adb793114", "name": "Contains a descriptive response.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5391f8ce-ea8d-4d3e-94f8-c99adb793114" }, { "id": "27275c06-aa53-4471-97db-b2a071db9874", "name": "Contains a descriptive information.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-27275c06-aa53-4471-97db-b2a071db9874" }, { "id": "1b75495f-74db-437d-af00-c5b2144eff8f", "name": "Contains a description of the error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1b75495f-74db-437d-af00-c5b2144eff8f" }, { "id": "8da147aa-ecec-43f4-9cf5-d66b590bf23c", "name": "Contains a description of the error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/:webhookId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", ":webhookId" ], "variable": [ { "key": "webhookId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8da147aa-ecec-43f4-9cf5-d66b590bf23c" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0be584e2-97c1-4c7f-ab66-c3e3ad278837" } ], "id": "0c86a969-a5bd-4ee2-a378-0a01b45433ec", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0c86a969-a5bd-4ee2-a378-0a01b45433ec" }, { "name": "verify", "item": [ { "name": "The endpoint used to validate that the webhook is working and reachable.", "id": "5eb55b97-1ddc-4e46-8904-86609ac0278c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] }, "description": "Validates the webhook URL endpoint from the connectivity point-of-view by sending a hello message and a 2xx success status code." }, "response": [ { "id": "fe2d0ea2-ba79-4507-985d-f99de72f3fe7", "name": "Webhook validated successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-fe2d0ea2-ba79-4507-985d-f99de72f3fe7" }, { "id": "b0f66f07-a395-497e-8c64-06f50c21e335", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b0f66f07-a395-497e-8c64-06f50c21e335" }, { "id": "06f1d830-cfd5-45cb-a32a-53cbc9515079", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-06f1d830-cfd5-45cb-a32a-53cbc9515079" }, { "id": "51917d29-a572-40c0-8ca5-3ca4fb0bfcc5", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-51917d29-a572-40c0-8ca5-3ca4fb0bfcc5" }, { "id": "bfec5442-66fa-4713-a669-77cc2d5347da", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-bfec5442-66fa-4713-a669-77cc2d5347da" }, { "id": "4f13e899-802e-4f25-aec7-48f92c09c35e", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"version\": \"\",\n \"uri\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks/verify", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks", "verify" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4f13e899-802e-4f25-aec7-48f92c09c35e" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5eb55b97-1ddc-4e46-8904-86609ac0278c" } ], "id": "b5054a17-3c3d-4072-9a77-bb0027ce9c77", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b5054a17-3c3d-4072-9a77-bb0027ce9c77" }, { "name": "Retrieves all customer webhooks based on the associated token information.", "id": "0960e500-73e2-4521-905c-0fa532e1feda", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] }, "description": "Retrieves all customer webhooks based on the associated token information." }, "response": [ { "id": "7f847226-f2fd-4376-8d03-09eab822c2f6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"webhooks\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7f847226-f2fd-4376-8d03-09eab822c2f6" }, { "id": "fbd73d63-4730-40cf-9031-33dd547b6f13", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-fbd73d63-4730-40cf-9031-33dd547b6f13" }, { "id": "be1a032d-9174-42c7-ba75-7bc9e4ad1ebb", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-be1a032d-9174-42c7-ba75-7bc9e4ad1ebb" }, { "id": "e1e89bb7-14ce-44bd-9fa3-d2910549b852", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e1e89bb7-14ce-44bd-9fa3-d2910549b852" }, { "id": "e7304063-04f5-43ae-b2e3-9148577267fb", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e7304063-04f5-43ae-b2e3-9148577267fb" }, { "id": "5f70f672-0830-4935-8ceb-17f10402cfbd", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5f70f672-0830-4935-8ceb-17f10402cfbd" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0960e500-73e2-4521-905c-0fa532e1feda" }, { "name": "Creates a new customer webhook.", "id": "63de24dd-fbf1-48f2-93c9-8ec04c160d69", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] }, "description": "Creates a new customer webhook." }, "response": [ { "id": "0d2f1201-ce6c-4031-9aa5-9feb4c483d52", "name": "WebHook created successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0d2f1201-ce6c-4031-9aa5-9feb4c483d52" }, { "id": "2ffe3247-0f93-4fc3-85fb-39cf74d2d825", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2ffe3247-0f93-4fc3-85fb-39cf74d2d825" }, { "id": "41b2b207-0a9c-4fd3-9216-6c047e01892d", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-41b2b207-0a9c-4fd3-9216-6c047e01892d" }, { "id": "930cfde5-7966-49e2-9c19-a08cacc31980", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-930cfde5-7966-49e2-9c19-a08cacc31980" }, { "id": "a9209de9-f745-40a5-8e66-5f81670173ff", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a9209de9-f745-40a5-8e66-5f81670173ff" }, { "id": "e3436d3b-3834-41e4-b927-537bf05cf6d8", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"uri\": \"\",\n \"version\": \"Chat Gateway v1.0\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "webhooks" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e3436d3b-3834-41e4-b927-537bf05cf6d8" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-63de24dd-fbf1-48f2-93c9-8ec04c160d69" } ], "id": "3d81cac1-a9ee-4888-976d-9841870a4774", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3d81cac1-a9ee-4888-976d-9841870a4774" }, { "name": "jwk", "item": [ { "name": "{jwkId}", "item": [ { "name": "public", "item": [ { "name": "Returns the public JWK.", "id": "d3cfcc6a-35cb-4cf0-a573-50dd5bb073e7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/jwk/:jwkId/public", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "jwk", ":jwkId", "public" ], "variable": [ { "id": "a9ec6a9d-1128-40c4-bceb-2301f2dd2918", "key": "jwkId", "value": "", "description": "(Required) JWK UUID" } ] }, "description": "Returns the public JWK that can be used to validate the message signature." }, "response": [ { "id": "040cb88d-f6ce-4b74-966d-3a50175e1eaf", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/jwk/:jwkId/public", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "jwk", ":jwkId", "public" ], "variable": [ { "key": "jwkId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-040cb88d-f6ce-4b74-966d-3a50175e1eaf" }, { "id": "158fda3f-2f54-4d12-b78a-822295b8d8b9", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/jwk/:jwkId/public", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "jwk", ":jwkId", "public" ], "variable": [ { "key": "jwkId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-158fda3f-2f54-4d12-b78a-822295b8d8b9" }, { "id": "cb1960d0-ae45-4d0b-ab3c-68737f1b2988", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/jwk/:jwkId/public", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "jwk", ":jwkId", "public" ], "variable": [ { "key": "jwkId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-cb1960d0-ae45-4d0b-ab3c-68737f1b2988" }, { "id": "4f161f92-1945-40aa-bcc1-79a5786f37e5", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/jwk/:jwkId/public", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "jwk", ":jwkId", "public" ], "variable": [ { "key": "jwkId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4f161f92-1945-40aa-bcc1-79a5786f37e5" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d3cfcc6a-35cb-4cf0-a573-50dd5bb073e7" } ], "id": "c70b2fd2-d380-4d97-9325-756443c03367", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c70b2fd2-d380-4d97-9325-756443c03367" } ], "id": "2ff67ef2-c43a-4790-92ef-2b2a6567fa35", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2ff67ef2-c43a-4790-92ef-2b2a6567fa35" } ], "id": "bdba3205-8643-432a-aa5f-3a5b8a9595a5", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-bdba3205-8643-432a-aa5f-3a5b8a9595a5" }, { "name": "channels", "item": [ { "name": "{channelId}", "item": [ { "name": "Get ChatAPI channel by Id.", "id": "b02469de-a100-4a4c-84eb-a6a129f1fab6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "id": "11fe94a6-1008-48d5-a7cb-d2aa44d44cf8", "key": "channelId", "value": "", "description": "(Required) ChatAPI channel identifier." } ] }, "description": "Retrieves ChatAPI channel by Id." }, "response": [ { "id": "97c1c025-e65f-466e-a989-d1c83b99ec60", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-97c1c025-e65f-466e-a989-d1c83b99ec60" }, { "id": "bb383124-15cf-498b-b2bd-096ba187049b", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-bb383124-15cf-498b-b2bd-096ba187049b" }, { "id": "7f4fb119-e429-4297-a41d-bb718cc3aae9", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7f4fb119-e429-4297-a41d-bb718cc3aae9" }, { "id": "10f78d03-29dc-4ad0-a4a4-3d244379b5a6", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-10f78d03-29dc-4ad0-a4a4-3d244379b5a6" }, { "id": "a1ad8ef6-e0c6-49de-bc73-51b5cd7795dc", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a1ad8ef6-e0c6-49de-bc73-51b5cd7795dc" }, { "id": "bd684850-ac7b-4794-9ae7-2b05942ed199", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-bd684850-ac7b-4794-9ae7-2b05942ed199" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b02469de-a100-4a4c-84eb-a6a129f1fab6" }, { "name": "Update ChatAPI channel by Id.", "id": "29a64ab2-3b37-417a-8dc6-caf447723fe6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "id": "9c730858-9267-454e-8418-03c5efb10601", "key": "channelId", "value": "", "description": "(Required) ChatAPI channel identifier." } ] }, "description": "Update ChatAPI channel by Id." }, "response": [ { "id": "3634646b-fef2-4f3d-8c72-663839d4fc79", "name": "Channel updated successfully.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3634646b-fef2-4f3d-8c72-663839d4fc79" }, { "id": "949797d0-350b-4812-aabf-c58c7e414911", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-949797d0-350b-4812-aabf-c58c7e414911" }, { "id": "27e00d05-156e-4194-a5af-5f66d9bbbcc1", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-27e00d05-156e-4194-a5af-5f66d9bbbcc1" }, { "id": "9c94bbb4-2131-49ca-b97e-2b23527136b8", "name": "Contains a descriptive response.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-9c94bbb4-2131-49ca-b97e-2b23527136b8" }, { "id": "22dca3a9-bed5-42e5-8316-0d7807fc4e07", "name": "Contains a descriptive information.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-22dca3a9-bed5-42e5-8316-0d7807fc4e07" }, { "id": "dae31985-3c8c-4a65-a762-87c6184c8260", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-dae31985-3c8c-4a65-a762-87c6184c8260" }, { "id": "dbdd2ac0-18c1-434d-920e-ffd71833d3b0", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-dbdd2ac0-18c1-434d-920e-ffd71833d3b0" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-29a64ab2-3b37-417a-8dc6-caf447723fe6" }, { "name": "Delete ChatAPI channel by Id.", "id": "0a000527-50d6-41d0-a254-a141dc780935", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "id": "a442eaa8-1a43-4d8f-b8a2-f68843d551e4", "key": "channelId", "value": "", "description": "(Required) ChatAPI channel identifier." } ] }, "description": "Deletes ChatAPI channel by the provided Id." }, "response": [ { "id": "b88db99e-d7fa-4d91-aae9-06625903b801", "name": "Deleted resource.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b88db99e-d7fa-4d91-aae9-06625903b801" }, { "id": "86928414-fe0c-4c2a-9133-f4dc33c40606", "name": "Contains a description of the error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-86928414-fe0c-4c2a-9133-f4dc33c40606" }, { "id": "42629d90-25ef-448d-a79f-087cf9d8de2f", "name": "Contains a descriptive response.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-42629d90-25ef-448d-a79f-087cf9d8de2f" }, { "id": "95a02187-2b1c-48e7-84d6-9e46cd726382", "name": "Contains a descriptive information.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-95a02187-2b1c-48e7-84d6-9e46cd726382" }, { "id": "dc0b65ee-958e-4e56-a467-9a363f8cd66d", "name": "Contains a description of the error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-dc0b65ee-958e-4e56-a467-9a363f8cd66d" }, { "id": "588acad0-1c10-4c53-9c6d-b002cea78952", "name": "Contains a description of the error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels/:channelId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels", ":channelId" ], "variable": [ { "key": "channelId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-588acad0-1c10-4c53-9c6d-b002cea78952" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0a000527-50d6-41d0-a254-a141dc780935" } ], "id": "d83ccf54-3049-4fcf-a86d-7c574917cfa0", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d83ccf54-3049-4fcf-a86d-7c574917cfa0" }, { "name": "Retrieves all customer Chat API channels.", "id": "5ca58462-279b-4177-a586-fa3312615c22", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] }, "description": "Retrieves all customer Chat API channels based on the provided access token information." }, "response": [ { "id": "b90c8da0-9cc8-4f9c-abd1-ba94298804e1", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"channels\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b90c8da0-9cc8-4f9c-abd1-ba94298804e1" }, { "id": "05c021b8-024b-4682-81d9-d3a86e68c313", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-05c021b8-024b-4682-81d9-d3a86e68c313" }, { "id": "7e83cf96-ddf8-4302-90bd-8a7d411ae7d4", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7e83cf96-ddf8-4302-90bd-8a7d411ae7d4" }, { "id": "13da1513-c4b2-4e9c-94da-63f87e858fbf", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-13da1513-c4b2-4e9c-94da-63f87e858fbf" }, { "id": "f41b8afb-3236-4084-bbc7-d642885c9bc8", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f41b8afb-3236-4084-bbc7-d642885c9bc8" }, { "id": "cb6cd926-1e50-4a5c-bd56-f26287c689b9", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-cb6cd926-1e50-4a5c-bd56-f26287c689b9" }, { "id": "94524045-4cdc-477d-902e-dc0a56458ff5", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-94524045-4cdc-477d-902e-dc0a56458ff5" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5ca58462-279b-4177-a586-fa3312615c22" }, { "name": "Creates a channel.", "id": "fc7b0def-d4cc-4bf7-b913-e6a5958c1293", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] }, "description": "Create a new channel for a customer." }, "response": [ { "id": "6afcf267-8363-4703-b488-d405e6314b49", "name": "Channel created successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-6afcf267-8363-4703-b488-d405e6314b49" }, { "id": "ef15fac6-edeb-4ed4-bff4-b9c43380ffb2", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ef15fac6-edeb-4ed4-bff4-b9c43380ffb2" }, { "id": "5e10284e-5670-4a90-b88f-63c3eae0a009", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5e10284e-5670-4a90-b88f-63c3eae0a009" }, { "id": "8340c4c5-8625-4c3a-a37a-66b4a60831ec", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8340c4c5-8625-4c3a-a37a-66b4a60831ec" }, { "id": "aba87eec-c9c0-4b6b-915b-3d92f4e4a9e2", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-aba87eec-c9c0-4b6b-915b-3d92f4e4a9e2" }, { "id": "a00ee0dc-8de9-4f7e-a636-5e8666b0e2ae", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"routingOptions\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"webHookId\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/channels", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "channels" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a00ee0dc-8de9-4f7e-a636-5e8666b0e2ae" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-fc7b0def-d4cc-4bf7-b913-e6a5958c1293" } ], "id": "2a92f974-eec2-4d91-95a4-39d16637ec45", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2a92f974-eec2-4d91-95a4-39d16637ec45" }, { "name": "conversations", "item": [ { "name": "{conversationId}", "item": [ { "name": "interactions", "item": [ { "name": "Returns all conversations belonging to the customer.", "id": "8fb5f99f-3988-42b5-b8d3-80db89fdbcae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "id": "63bc1c56-fc4d-493f-8096-d6c902572a31", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Returns a list of all conversations belonging to the customer that comply with the provided filters." }, "response": [ { "id": "d6a706bf-ea4f-4794-ae91-f68e060d9ba9", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"interactions\": [\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n },\n {\n \"id\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d6a706bf-ea4f-4794-ae91-f68e060d9ba9" }, { "id": "7cf44b2c-f78e-4150-9188-030ff6664cba", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7cf44b2c-f78e-4150-9188-030ff6664cba" }, { "id": "1c825a80-f72f-424e-8d06-22e3cbf6acd5", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1c825a80-f72f-424e-8d06-22e3cbf6acd5" }, { "id": "0eadf01d-fd5c-4594-9ba0-179c7458997c", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0eadf01d-fd5c-4594-9ba0-179c7458997c" }, { "id": "df79aa13-40e0-4272-8ff7-a32ee021fc7d", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-df79aa13-40e0-4272-8ff7-a32ee021fc7d" }, { "id": "739f70bd-4954-4fcf-b36d-9f81a7ff3a9e", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-739f70bd-4954-4fcf-b36d-9f81a7ff3a9e" }, { "id": "0d7b5b73-d57f-4732-a85f-53891df69393", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/interactions", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "interactions" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0d7b5b73-d57f-4732-a85f-53891df69393" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8fb5f99f-3988-42b5-b8d3-80db89fdbcae" } ], "id": "3604f0a6-1449-4ac3-9780-55d46e23ec88", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3604f0a6-1449-4ac3-9780-55d46e23ec88" }, { "name": "post-agent-assignment", "item": [ { "name": "Creates a post agent assignment for a conversation.", "id": "2cf6e902-4e9f-46fd-89cf-76217279dde6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "id": "1c1a39ee-27b2-47e2-9949-d2469a025279", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Creates a post-agent assignment for a conversation. This endpoint allows the conversation to be handed back to the bot after an agent finishes their interaction, to ensure seamless continuation of the customer's digital journey after agent interactions, allowing for tasks such as surveys or further automated assistance. The flexible assignment mechanism supports various post-conversation workflows and is designed to be extensible for different use cases after the agent engagement has concluded." }, "response": [ { "id": "fa690d44-32c7-487a-b319-c037a93e1704", "name": "CREATED", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-fa690d44-32c7-487a-b319-c037a93e1704" }, { "id": "0326f065-6f78-49e6-803a-a5e7518e22e0", "name": "Contains a descriptive response for a bad request that is due to data validation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0326f065-6f78-49e6-803a-a5e7518e22e0" }, { "id": "bf991b50-1164-4e73-8343-2ed5e33e6d75", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-bf991b50-1164-4e73-8343-2ed5e33e6d75" }, { "id": "9fce3fab-6548-425e-a7cf-d955d14f7ed8", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-9fce3fab-6548-425e-a7cf-d955d14f7ed8" }, { "id": "656af396-1e34-4378-9fbe-c3efe18f8c02", "name": "Contains a descriptive information.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-656af396-1e34-4378-9fbe-c3efe18f8c02" }, { "id": "eb369b4f-0151-4c70-aaaf-d31f692cae94", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-eb369b4f-0151-4c70-aaaf-d31f692cae94" }, { "id": "7e3c101a-f5aa-46e2-b620-154e4fd120d0", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"webhook\",\n \"id\": \"\",\n \"configuration\": {\n \"notifyChannelWebhookIfExists\": \"\",\n \"maxTotalMinutes\": \"\",\n \"userTimeoutInMinutes\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/post-agent-assignment", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "post-agent-assignment" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7e3c101a-f5aa-46e2-b620-154e4fd120d0" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2cf6e902-4e9f-46fd-89cf-76217279dde6" } ], "id": "329b7051-5ddc-4432-8612-edd4c3e90e84", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-329b7051-5ddc-4432-8612-edd4c3e90e84" }, { "name": "typing", "item": [ { "name": "Creates a typing indicator for a conversation.", "id": "df15c321-20b6-4817-b2c9-e3dc2d99ccab", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "id": "94072b51-bd92-49ad-85e0-2ad3179c63ec", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": " Sends a typing indicator to the Chalet room associated with the given conversation. Requires an authorType of either 'user' or 'bot' to determine the identity used when sending the indicator." }, "response": [ { "id": "53fb436d-8457-40c9-8718-657056763455", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-53fb436d-8457-40c9-8718-657056763455" }, { "id": "519a7410-3479-4307-9740-6f54a426077d", "name": "Contains a descriptive response for a bad request that is due to data validation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-519a7410-3479-4307-9740-6f54a426077d" }, { "id": "5f222fb7-07ab-4a8c-8ed0-a8f9aaefbc96", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5f222fb7-07ab-4a8c-8ed0-a8f9aaefbc96" }, { "id": "aaaf426a-80cb-4e97-a6bc-1a5a358efa62", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-aaaf426a-80cb-4e97-a6bc-1a5a358efa62" }, { "id": "5f28e31c-3491-4475-9f4b-4ff857301f3e", "name": "Contains a descriptive information.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5f28e31c-3491-4475-9f4b-4ff857301f3e" }, { "id": "353fb6c1-3884-4746-a684-adea53781598", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-353fb6c1-3884-4746-a684-adea53781598" }, { "id": "a953212f-523a-4f46-8b9b-6d8108466933", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/typing", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "typing" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a953212f-523a-4f46-8b9b-6d8108466933" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-df15c321-20b6-4817-b2c9-e3dc2d99ccab" } ], "id": "563f0b5f-ae4e-4756-bb70-06e29d670286", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-563f0b5f-ae4e-4756-bb70-06e29d670286" }, { "name": "thinking", "item": [ { "name": "Sends a thinking indicator for a conversation.", "id": "48ab0817-e516-4b2c-8967-fd9c165012b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "id": "5cd87471-bb70-4dae-ba65-6b5e35e9c92c", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Sends a thinking indicator notification to the Chalet backplane room-update resource, signaling that the bot is processing. The request body is optional; when omitted, defaults are applied (authorType='bot', maxThinkingTimeSeconds=60)." }, "response": [ { "id": "59d5d82c-95aa-4f35-a85f-7467c5d32abf", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-59d5d82c-95aa-4f35-a85f-7467c5d32abf" }, { "id": "23f46cc9-ae95-47a0-a2a8-c007276528cd", "name": "Contains a descriptive response for a bad request that is due to data validation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-23f46cc9-ae95-47a0-a2a8-c007276528cd" }, { "id": "a1ac236a-c1e3-499e-b793-784f65c40e24", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a1ac236a-c1e3-499e-b793-784f65c40e24" }, { "id": "0f94c8ef-92b1-436f-aa50-33a127bb8b05", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0f94c8ef-92b1-436f-aa50-33a127bb8b05" }, { "id": "435955bd-a763-422e-87aa-28034b9cddf4", "name": "Contains a descriptive information.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-435955bd-a763-422e-87aa-28034b9cddf4" }, { "id": "4fb7f495-1c0a-48f3-a0a0-52760065226a", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4fb7f495-1c0a-48f3-a0a0-52760065226a" }, { "id": "976137be-e02d-4aad-87ac-d4fb8024bd14", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"maxThinkingTimeSeconds\": 60\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/thinking", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "thinking" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-976137be-e02d-4aad-87ac-d4fb8024bd14" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-48ab0817-e516-4b2c-8967-fd9c165012b8" } ], "id": "6376152f-f3bc-44dd-9f91-372dee7b7963", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-6376152f-f3bc-44dd-9f91-372dee7b7963" }, { "name": "read-receipt", "item": [ { "name": "Sends a read receipt for a conversation.", "id": "79fee8bb-3e09-4bee-9f38-d7aeb3dc5a27", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "id": "db309651-b509-4ef3-9dce-34339aea3274", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Sends a read receipt to the Chalet room associated with the given conversation, indicating that all messages up to the given timestamp have been read. Requires an authorType of either 'user' or 'bot'. The 'user' authorType is only allowed for CHAT_API channels." }, "response": [ { "id": "b9743b59-0b7c-4364-ae1a-f3ba59c3d32f", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b9743b59-0b7c-4364-ae1a-f3ba59c3d32f" }, { "id": "25bd266b-d6c7-43e5-83f7-0c17e376812b", "name": "Contains a descriptive response for a bad request that is due to data validation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-25bd266b-d6c7-43e5-83f7-0c17e376812b" }, { "id": "f805bd1e-dd2d-41ea-8d25-73f808b40340", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f805bd1e-dd2d-41ea-8d25-73f808b40340" }, { "id": "f69974c2-a008-4877-a517-96b68ef3b446", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f69974c2-a008-4877-a517-96b68ef3b446" }, { "id": "92e23335-f8b9-4916-9464-dc3fc729a098", "name": "Contains a descriptive information.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-92e23335-f8b9-4916-9464-dc3fc729a098" }, { "id": "593c5565-0828-4943-8be6-f872f50835c0", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-593c5565-0828-4943-8be6-f872f50835c0" }, { "id": "853f6d9b-b6cc-43df-b718-ae34fb9a77e8", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"bot\",\n \"readAt\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/read-receipt", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "read-receipt" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-853f6d9b-b6cc-43df-b718-ae34fb9a77e8" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-79fee8bb-3e09-4bee-9f38-d7aeb3dc5a27" } ], "id": "6e0a0121-2920-4e73-9122-f7feb02e156b", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-6e0a0121-2920-4e73-9122-f7feb02e156b" }, { "name": "participants", "item": [ { "name": "user", "item": [ { "name": "User leaves conversation.", "id": "c6cb7932-a13d-411e-9c41-16fa26bc22bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "id": "2d0e3fc1-5d09-456b-ab26-5cee8c3fdd56", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "When user leave a conversation. It translates to a current interaction that is being terminated by the user." }, "response": [ { "id": "ec5a0fca-19d5-4825-b12a-e56b68afb55a", "name": "Confirms that the user left the interaction.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "key": "conversationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ec5a0fca-19d5-4825-b12a-e56b68afb55a" }, { "id": "650d8b95-5f64-44c1-bb7b-a44346ba21ec", "name": "Contains a description of the error.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-650d8b95-5f64-44c1-bb7b-a44346ba21ec" }, { "id": "81775410-daef-43d8-8242-426b69b2af1c", "name": "Contains a descriptive response.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-81775410-daef-43d8-8242-426b69b2af1c" }, { "id": "89a11a09-8ccc-478a-b544-dbf5ff4ef1be", "name": "Contains a descriptive information.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-89a11a09-8ccc-478a-b544-dbf5ff4ef1be" }, { "id": "9eb18fa9-dd14-48fd-aa77-768eb64f3a26", "name": "Contains a description of the error.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-9eb18fa9-dd14-48fd-aa77-768eb64f3a26" }, { "id": "f59472c1-d513-4425-92fc-be9fca8b7b15", "name": "Confirms that the user left the interaction.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"removed\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants/user", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants", "user" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f59472c1-d513-4425-92fc-be9fca8b7b15" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c6cb7932-a13d-411e-9c41-16fa26bc22bf" } ], "id": "e59888c1-33a8-44a4-bb28-429b1eb228c7", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e59888c1-33a8-44a4-bb28-429b1eb228c7" }, { "name": "Retrieve the conversation participants.", "id": "2a23d9b5-976d-4126-b169-d66eeb4be20b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "id": "4e20129e-824b-42c1-bf42-0c970c1d0679", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Retrieves all the participants that joined during the lifespan of the conversation." }, "response": [ { "id": "3bb30c04-bf8f-476e-9fa0-0d3a38f62545", "name": "Participants list", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "key": "conversationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"participants\": [\n {\n \"id\": \"\",\n \"removed\": \"\",\n \"type\": \"user\",\n \"language\": \"en\"\n },\n {\n \"id\": \"\",\n \"removed\": \"\",\n \"type\": \"user\",\n \"language\": \"en\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3bb30c04-bf8f-476e-9fa0-0d3a38f62545" }, { "id": "44643a8e-07d8-47d4-a684-78b4aa6624c2", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-44643a8e-07d8-47d4-a684-78b4aa6624c2" }, { "id": "af18ab39-11e1-4ea0-98c8-257a056a6f28", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-af18ab39-11e1-4ea0-98c8-257a056a6f28" }, { "id": "c5be2e50-00c6-4d21-917d-be6d9fef36e8", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c5be2e50-00c6-4d21-917d-be6d9fef36e8" }, { "id": "07ca4ad6-5aab-4c0a-b90f-eb4d21b0d93b", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-07ca4ad6-5aab-4c0a-b90f-eb4d21b0d93b" }, { "id": "5a017b14-855d-418d-8a8f-0e34254841ab", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/participants", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "participants" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5a017b14-855d-418d-8a8f-0e34254841ab" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2a23d9b5-976d-4126-b169-d66eeb4be20b" } ], "id": "ef3f5f2d-0783-4222-b32c-8f63a54b08fd", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ef3f5f2d-0783-4222-b32c-8f63a54b08fd" }, { "name": "messages", "item": [ { "name": "{messageId}", "item": [ { "name": "cards", "item": [ { "name": "Retrieves the list of conversation message cards.", "id": "33fda377-1e8e-4536-a404-edf261f96a76", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "id": "d3f0a334-8469-426c-b24c-136c14291842", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." }, { "id": "682d30e7-9a27-42e3-9c23-adac8ca3edb8", "key": "messageId", "value": "", "description": "(Required) Message identifier." } ] }, "description": "Retrieves list of conversation message cards. Either Adaptive Cards or Quick Replies." }, "response": [ { "id": "f4f2adbe-a0bb-4f5a-9279-d2eca06ab1d4", "name": "Cards list", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f4f2adbe-a0bb-4f5a-9279-d2eca06ab1d4" }, { "id": "c8bce1b9-ba8e-42a5-9498-465f734cd9e4", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c8bce1b9-ba8e-42a5-9498-465f734cd9e4" }, { "id": "71c8f0b1-3533-4e25-9f80-7ab107d77e01", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-71c8f0b1-3533-4e25-9f80-7ab107d77e01" }, { "id": "3da689db-ec38-4503-ba41-371edb7fe1fc", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3da689db-ec38-4503-ba41-371edb7fe1fc" }, { "id": "3e9be5c2-8d5d-475b-816a-647dc667d978", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3e9be5c2-8d5d-475b-816a-647dc667d978" }, { "id": "c28a57c1-805a-4e09-af29-77d9f242eaea", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId/cards?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId", "cards" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c28a57c1-805a-4e09-af29-77d9f242eaea" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-33fda377-1e8e-4536-a404-edf261f96a76" } ], "id": "16831362-6d8b-42ad-98e9-527a8fc53992", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-16831362-6d8b-42ad-98e9-527a8fc53992" }, { "name": "Retrieves the conversation messages.", "id": "d6b987d9-841a-4679-b551-c1126cfefc74", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "id": "f9d097a8-9590-4476-9625-68158be6604a", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." }, { "id": "9f06ea20-af74-4ec4-9013-636e608981ed", "key": "messageId", "value": "", "description": "(Required) Message identifier." } ] }, "description": "Retrieves the conversation messages that took place during the lifespan of the conversation." }, "response": [ { "id": "771fea6b-ad94-4ac6-8a73-9790869fa54e", "name": "Message list", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"text\": \"\",\n \"author\": {\n \"id\": \"\",\n \"removed\": \"\",\n \"type\": \"user\",\n \"language\": \"en\"\n },\n \"createdAt\": \"\",\n \"externalProvider\": {\n \"name\": \"X\",\n \"externalMessageId\": \"\"\n },\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-771fea6b-ad94-4ac6-8a73-9790869fa54e" }, { "id": "cfa535dd-1212-41e5-9771-815adbb8aaa6", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-cfa535dd-1212-41e5-9771-815adbb8aaa6" }, { "id": "4981fbe9-b3c1-41e8-8cbf-00e1555eb6b8", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4981fbe9-b3c1-41e8-8cbf-00e1555eb6b8" }, { "id": "0cf8600b-ceef-408e-9ad0-07727be3bdd5", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0cf8600b-ceef-408e-9ad0-07727be3bdd5" }, { "id": "ce17e90b-b08e-4581-b250-c551da6eb73b", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ce17e90b-b08e-4581-b250-c551da6eb73b" }, { "id": "9f0de340-2904-45a8-a5f9-277cbaea4027", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages", ":messageId" ], "variable": [ { "key": "conversationId" }, { "key": "messageId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-9f0de340-2904-45a8-a5f9-277cbaea4027" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d6b987d9-841a-4679-b551-c1126cfefc74" } ], "id": "758a7c70-4704-4baa-8b74-74a9deac451d", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-758a7c70-4704-4baa-8b74-74a9deac451d" }, { "name": "Retrieves the conversation messages.", "id": "12c3abf6-7f5c-4a6e-9ccc-fa5000da1aae", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "id": "f699d6c9-a20a-4326-b407-3427cab0a1d0", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Retrieves the conversation messages that took place during the lifespan of the conversation." }, "response": [ { "id": "c62fbe8f-17b9-40a8-a71c-ee8f36ed3df2", "name": "Message list", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"messages\": [\n {\n \"id\": \"\",\n \"text\": \"\",\n \"author\": {\n \"id\": \"\",\n \"removed\": \"\",\n \"type\": \"user\",\n \"language\": \"en\"\n },\n \"createdAt\": \"\",\n \"externalProvider\": {\n \"name\": \"X\",\n \"externalMessageId\": \"\"\n },\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"text\": \"\",\n \"author\": {\n \"id\": \"\",\n \"removed\": \"\",\n \"type\": \"user\",\n \"language\": \"en\"\n },\n \"createdAt\": \"\",\n \"externalProvider\": {\n \"name\": \"X\",\n \"externalMessageId\": \"\"\n },\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c62fbe8f-17b9-40a8-a71c-ee8f36ed3df2" }, { "id": "b1ec38e4-02a1-4ee9-a0b3-a9f6874728c9", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b1ec38e4-02a1-4ee9-a0b3-a9f6874728c9" }, { "id": "18658979-873b-4291-a0a5-079b64c8d863", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-18658979-873b-4291-a0a5-079b64c8d863" }, { "id": "0f5baeba-646b-43a5-9d65-e284c3561a34", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0f5baeba-646b-43a5-9d65-e284c3561a34" }, { "id": "04ce61c0-f68d-4219-9889-1253db4bbd9c", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-04ce61c0-f68d-4219-9889-1253db4bbd9c" }, { "id": "e3807b42-792e-43e1-b267-26c50ffac87c", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages?size=20&page=0&sort=createdAt:desc", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied available only for createdDate field.", "key": "sort", "value": "createdAt:desc" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e3807b42-792e-43e1-b267-26c50ffac87c" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-12c3abf6-7f5c-4a6e-9ccc-fa5000da1aae" }, { "name": "Send a message.", "id": "92ef3547-9f75-4d09-b411-6105eb5fa51a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "id": "01d01097-6ad2-4cb6-a8d7-79ef1a0896f0", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Send a message to a conversation represented by the provided ID." }, "response": [ { "id": "e09c887c-8157-4efc-b086-f80ffd02b4c9", "name": "Accepted message.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e09c887c-8157-4efc-b086-f80ffd02b4c9" }, { "id": "1acae7a9-9370-41f4-817e-f18a2931437c", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1acae7a9-9370-41f4-817e-f18a2931437c" }, { "id": "3e05a13c-0f97-46f1-b2f8-f8945f40e13a", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-3e05a13c-0f97-46f1-b2f8-f8945f40e13a" }, { "id": "2dde9169-fcd6-4079-b105-bf930782a5aa", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2dde9169-fcd6-4079-b105-bf930782a5aa" }, { "id": "beed8592-5d4d-455e-863d-abb9744a4076", "name": "Contains a descriptive information.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-beed8592-5d4d-455e-863d-abb9744a4076" }, { "id": "325b478f-66e0-4d33-b71c-2a65b1d8b08d", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-325b478f-66e0-4d33-b71c-2a65b1d8b08d" }, { "id": "08d968bd-3883-4163-9c57-28e91cf72ae0", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/messages", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "messages" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-08d968bd-3883-4163-9c57-28e91cf72ae0" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-92ef3547-9f75-4d09-b411-6105eb5fa51a" } ], "id": "9451d92d-f2a3-477d-a341-53ef1555df12", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-9451d92d-f2a3-477d-a341-53ef1555df12" }, { "name": "attachments", "item": [ { "name": "{attachmentId}", "item": [ { "name": "content", "item": [ { "name": "Download attachment.", "id": "abca8f8a-c8c4-4efd-88d5-73bb994232b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "id": "9c876080-ab90-468b-b6ff-89811868ef00", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." }, { "id": "24bae04e-53ff-4554-bab9-8a0fb24148b5", "key": "attachmentId", "value": "", "description": "(Required) Attachment ID" } ] }, "description": "Download attachment contents." }, "response": [ { "id": "55fdbc3e-9d27-4d56-ae73-58a63d0a8be6", "name": "Attachments content", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" }, { "disabled": false, "description": { "content": "Content-Disposition response header is a header indicating if the content is expected to be displayed inline in the browser, that is, as a Web page or as part of a Web page, or as an attachment, that is downloaded and saved locally.", "type": "text/plain" }, "key": "Content-Disposition", "value": "" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-55fdbc3e-9d27-4d56-ae73-58a63d0a8be6" }, { "id": "7e79e0de-26a8-4e94-93c8-0d943a91d603", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7e79e0de-26a8-4e94-93c8-0d943a91d603" }, { "id": "d6c40edf-6160-4aa4-b373-577fb46bad04", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d6c40edf-6160-4aa4-b373-577fb46bad04" }, { "id": "0d186d03-cef6-4823-9e8a-e0983845a509", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0d186d03-cef6-4823-9e8a-e0983845a509" }, { "id": "6953e2c7-d93e-414e-9944-c425672301e9", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-6953e2c7-d93e-414e-9944-c425672301e9" }, { "id": "f8750292-a837-4b3a-9eb4-362bfb648a99", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId/content", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId", "content" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f8750292-a837-4b3a-9eb4-362bfb648a99" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-abca8f8a-c8c4-4efd-88d5-73bb994232b6" } ], "id": "1b16bcf4-271a-49a8-b14f-db46400e0bc9", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1b16bcf4-271a-49a8-b14f-db46400e0bc9" }, { "name": "Get an attachment from Conversation.", "id": "8d11925a-e6b2-4279-a0ef-2f20faef5270", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "id": "d680e78b-4cdc-43b4-9834-05ae6aa4e0d3", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." }, { "id": "357c7680-740d-45d9-902a-0938298b0645", "key": "attachmentId", "value": "", "description": "(Required) Attachment ID" } ] }, "description": "Get an attachment from conversation along with their details." }, "response": [ { "id": "37514314-7e0b-47ae-859d-c2e6ea899df2", "name": "Attachments list", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"filename\": \"\",\n \"createdAt\": \"\",\n \"sizeInBytes\": \"\",\n \"size\": true\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-37514314-7e0b-47ae-859d-c2e6ea899df2" }, { "id": "dba7bcca-bbb5-439c-9890-bd49560e4354", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-dba7bcca-bbb5-439c-9890-bd49560e4354" }, { "id": "d7d23227-5c10-4a7a-9ccc-08a129e7152a", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d7d23227-5c10-4a7a-9ccc-08a129e7152a" }, { "id": "cfe466bb-526d-492f-a7ab-7a2c431746af", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-cfe466bb-526d-492f-a7ab-7a2c431746af" }, { "id": "1f384d72-7235-4e82-bbea-872f8b680c46", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1f384d72-7235-4e82-bbea-872f8b680c46" }, { "id": "5a57743f-a134-4014-9797-a2fa8069276c", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments/:attachmentId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments", ":attachmentId" ], "variable": [ { "key": "conversationId" }, { "key": "attachmentId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5a57743f-a134-4014-9797-a2fa8069276c" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8d11925a-e6b2-4279-a0ef-2f20faef5270" } ], "id": "93120fef-5388-4a4e-996f-97fe20da3612", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-93120fef-5388-4a4e-996f-97fe20da3612" }, { "name": "Get attachments in Conversation.", "id": "00ffaf7f-a09d-4c29-8e2d-96095680bfd0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "id": "c2eed1e9-f6d8-4a3b-a56f-4e9cdd6344a6", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Get all attachments added to the conversation along with their details." }, "response": [ { "id": "df1834dc-db31-4764-a33d-c33a871e1f4c", "name": "Attachments list", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"attachments\": [\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdAt\": \"\",\n \"sizeInBytes\": \"\",\n \"size\": 84690214.15511963\n },\n {\n \"id\": \"\",\n \"filename\": \"\",\n \"createdAt\": \"\",\n \"sizeInBytes\": \"\",\n \"size\": 40349581\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-df1834dc-db31-4764-a33d-c33a871e1f4c" }, { "id": "436b7726-0847-4a45-924c-6d169906ddb8", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-436b7726-0847-4a45-924c-6d169906ddb8" }, { "id": "a14e1112-a3f9-40ee-bf1c-bf9c60f503a8", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a14e1112-a3f9-40ee-bf1c-bf9c60f503a8" }, { "id": "ff6883ff-6764-44ab-a92c-af6cded2b7b8", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ff6883ff-6764-44ab-a92c-af6cded2b7b8" }, { "id": "5a2aed29-deda-4ad5-ad19-9a404de195a2", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5a2aed29-deda-4ad5-ad19-9a404de195a2" }, { "id": "f737a49f-50bc-4ed3-9970-8c06c8a8126c", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f737a49f-50bc-4ed3-9970-8c06c8a8126c" }, { "id": "1ea85aeb-1fb8-4f40-8848-08996471c4e5", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1ea85aeb-1fb8-4f40-8848-08996471c4e5" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-00ffaf7f-a09d-4c29-8e2d-96095680bfd0" }, { "name": "Add an attachment.", "id": "c5dfdb5b-f5a6-4537-aa06-9b7094b9655b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file", "value": null }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "id": "a0430544-288b-4848-88c8-ad8fb7deb570", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Add an attachment that you can later use as a reference when adding a message to the conversation." }, "response": [ { "id": "0db20074-12ae-45e4-842f-b856a7452ca9", "name": "Created attachment", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file" }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "key": "conversationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"filename\": \"\",\n \"createdAt\": \"\",\n \"sizeInBytes\": \"\",\n \"size\": true\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0db20074-12ae-45e4-842f-b856a7452ca9" }, { "id": "a2eb195b-cc72-44b2-af99-b1af1a94eb71", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file" }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a2eb195b-cc72-44b2-af99-b1af1a94eb71" }, { "id": "dae79ef2-bb28-436a-8a1d-3b8e0c7fa284", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file" }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-dae79ef2-bb28-436a-8a1d-3b8e0c7fa284" }, { "id": "81142b81-88d7-4944-8dbc-05f72aeec76c", "name": "Contains a descriptive information.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file" }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-81142b81-88d7-4944-8dbc-05f72aeec76c" }, { "id": "1deb74ee-1bea-4d4c-b5eb-7932356087e9", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file" }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-1deb74ee-1bea-4d4c-b5eb-7932356087e9" }, { "id": "0b60830c-d975-4a1c-81cc-da1584ba41c3", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "attachment", "type": "file" }, { "key": "authorType", "value": "user", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId/attachments", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId", "attachments" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0b60830c-d975-4a1c-81cc-da1584ba41c3" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c5dfdb5b-f5a6-4537-aa06-9b7094b9655b" } ], "id": "f97dec1d-beac-4f23-af73-d5b2dde8a869", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f97dec1d-beac-4f23-af73-d5b2dde8a869" }, { "name": "Update a conversation details.", "id": "c1123aa5-e18b-4061-8b21-e9b15a004b64", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "id": "510e60e6-04de-410a-b710-8a2ad356ec62", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Update a conversation details." }, "response": [ { "id": "e2cc3dfe-5c1a-4965-bc57-1c509e08e90f", "name": "Transaction accepted. Assignment changes are still processing and the success of the operation will be reflected by the webhook event or by the changes to the assignment field in the conversation resource.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channelId\": \"\",\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"state\": \"created\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e2cc3dfe-5c1a-4965-bc57-1c509e08e90f" }, { "id": "8b961212-ed96-4f8c-9e9c-30891318e98e", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8b961212-ed96-4f8c-9e9c-30891318e98e" }, { "id": "9d333190-3754-4b0f-9409-d35d7fa82ea8", "name": "Contains a descriptive response.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-9d333190-3754-4b0f-9409-d35d7fa82ea8" }, { "id": "4ff34e6c-0720-4b33-a769-df64fc9e3e67", "name": "Contains a descriptive information.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4ff34e6c-0720-4b33-a769-df64fc9e3e67" }, { "id": "afa0d960-c817-4cbd-bcca-e5840388800b", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-afa0d960-c817-4cbd-bcca-e5840388800b" }, { "id": "7762f71e-1458-43de-a97a-39b0a29e4354", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7762f71e-1458-43de-a97a-39b0a29e4354" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c1123aa5-e18b-4061-8b21-e9b15a004b64" }, { "name": "Patch a conversation details.", "id": "84ac68c8-caf1-42ff-a124-1d9a5379fcba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "id": "bdf75f40-023a-490c-99e0-e17d5fec35b2", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Patch a conversation details." }, "response": [ { "id": "7e0e1b08-9c9b-4b2f-8673-8d3c5c5545a9", "name": "Transaction accepted. Assignment changes are still processing and the success of the operation will be reflected by the webhook event or by the changes to the assignment field in the conversation resource.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channelId\": \"\",\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"state\": \"created\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-7e0e1b08-9c9b-4b2f-8673-8d3c5c5545a9" }, { "id": "ac1aa380-5c27-4821-a2e5-363924036160", "name": "Contains a description of the error.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ac1aa380-5c27-4821-a2e5-363924036160" }, { "id": "e35aa006-91b1-418d-a6e7-a1a16599ad01", "name": "Contains a descriptive response.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e35aa006-91b1-418d-a6e7-a1a16599ad01" }, { "id": "8412b31d-d47d-4dcb-bf12-99ffc278d05f", "name": "Contains a descriptive information.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8412b31d-d47d-4dcb-bf12-99ffc278d05f" }, { "id": "5e63716c-9796-45c0-9b6d-d12dbfcff5e5", "name": "Contains a description of the error.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5e63716c-9796-45c0-9b6d-d12dbfcff5e5" }, { "id": "b6785076-63ba-40c3-b152-51efa0e90280", "name": "Contains a description of the error.", "originalRequest": { "method": "PATCH", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-b6785076-63ba-40c3-b152-51efa0e90280" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-84ac68c8-caf1-42ff-a124-1d9a5379fcba" }, { "name": "Retrieves conversation details.", "id": "d9d53549-5a8e-4029-983f-388d97f6c423", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "id": "78678685-a6cd-410b-93c4-abafd893e235", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." } ] }, "description": "Retrieves conversation details." }, "response": [ { "id": "fd808576-2a2e-4d24-b957-03661c87ae6a", "name": "Returns the conversation details.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channelId\": \"\",\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"state\": \"created\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-fd808576-2a2e-4d24-b957-03661c87ae6a" }, { "id": "a6f577f5-2d65-468e-95d8-2bd9adca9128", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a6f577f5-2d65-468e-95d8-2bd9adca9128" }, { "id": "f01c7123-19ff-4645-8970-8b861796d67a", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f01c7123-19ff-4645-8970-8b861796d67a" }, { "id": "f3a730cc-7dfa-4d20-887a-cd62b0f0ea48", "name": "Contains a descriptive information.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f3a730cc-7dfa-4d20-887a-cd62b0f0ea48" }, { "id": "eed7cb27-c657-418c-8503-06d9fb5e2165", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-eed7cb27-c657-418c-8503-06d9fb5e2165" }, { "id": "692f300a-6d35-4c1a-ae9b-cb042f180502", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations/:conversationId", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations", ":conversationId" ], "variable": [ { "key": "conversationId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-692f300a-6d35-4c1a-ae9b-cb042f180502" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d9d53549-5a8e-4029-983f-388d97f6c423" } ], "id": "d716e797-545d-44cf-bce5-f9327448f8d8", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d716e797-545d-44cf-bce5-f9327448f8d8" }, { "name": "Returns all conversations belonging to the customer.", "id": "5ad3ce9c-49ea-4bb7-8f09-d0126973faac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] }, "description": "Returns a list of all conversations belonging to the customer that comply with the provided filters." }, "response": [ { "id": "6cb6f029-e9bb-4ecf-8703-d9cdb9484661", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"_embedded\": {\n \"conversations\": [\n {\n \"channelId\": \"\",\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"state\": \"created\"\n },\n {\n \"channelId\": \"\",\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"state\": \"created\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"page\": {\n \"size\": \"\",\n \"number\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n }\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-6cb6f029-e9bb-4ecf-8703-d9cdb9484661" }, { "id": "de5e80ae-43dc-4b03-b217-989bbe195530", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-de5e80ae-43dc-4b03-b217-989bbe195530" }, { "id": "2ec73ada-80f0-446f-9235-2ce4cf157704", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2ec73ada-80f0-446f-9235-2ce4cf157704" }, { "id": "6e17a53f-dcfd-4ba3-be84-93d14157abe5", "name": "Contains a descriptive response.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-6e17a53f-dcfd-4ba3-be84-93d14157abe5" }, { "id": "ba930bc4-c906-4a5e-abef-b75ef6bd879c", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ba930bc4-c906-4a5e-abef-b75ef6bd879c" }, { "id": "f21ef6f2-a269-40ac-a6da-bc31aa08ba64", "name": "Contains a description of the error.", "originalRequest": { "method": "GET", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations?size=20&page=0&sort=id:asc&filter=", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ], "query": [ { "description": "Response page size.", "key": "size", "value": "20" }, { "description": "Response page index.", "key": "page", "value": "0" }, { "description": "Attribute on which sorting direction is applied.", "key": "sort", "value": "id:asc" }, { "description": "Filter for a query in FIQL format.", "key": "filter", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-f21ef6f2-a269-40ac-a6da-bc31aa08ba64" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5ad3ce9c-49ea-4bb7-8f09-d0126973faac" }, { "name": "Creates a new conversation.", "id": "8cedeed2-0c9a-4fa4-8676-cbab8030d51d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] }, "description": "Creates a new transaction in the Contact Center and returns a conversation Id as an identifier that can be used later on to send messages to agent and also close the ongoing transaction." }, "response": [ { "id": "99857e0d-053e-4669-b200-8b1b22eadcd9", "name": "Conversation entity is created and the associated interaction is in the process of being created. The state of the conversation entity is CREATED and the first webhook event is sent with CREATED state. A webhook event stating that the conversation is ACTI", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/hal+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/hal+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"conversationId\": \"\",\n \"createdAt\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-99857e0d-053e-4669-b200-8b1b22eadcd9" }, { "id": "a7b185e1-c6df-4096-a44b-5f059ab44648", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-a7b185e1-c6df-4096-a44b-5f059ab44648" }, { "id": "696846b2-5d9d-4fe8-8d6e-78bb2196aba3", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-696846b2-5d9d-4fe8-8d6e-78bb2196aba3" }, { "id": "238062a9-420f-42da-a400-cb08bc13d9ca", "name": "Contains a descriptive response.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-238062a9-420f-42da-a400-cb08bc13d9ca" }, { "id": "0afa00e7-feb7-4570-a801-50cb7e7b8191", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0afa00e7-feb7-4570-a801-50cb7e7b8191" }, { "id": "de4f5937-8dc9-4c43-bc03-f8180dd54b89", "name": "Contains a description of the error.", "originalRequest": { "method": "POST", "header": [ { "description": "Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.", "key": "X-8x8-Tenant", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"channelId\": \"\",\n \"user\": {\n \"name\": \"\",\n \"userId\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"caseId\": \"\",\n \"language\": \"en\",\n \"additionalProperties\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"assignment\": {\n \"type\": \"queue\",\n \"id\": \"\"\n },\n \"history\": {\n \"messages\": [\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n },\n {\n \"authorType\": \"user\",\n \"text\": \"\",\n \"attachments\": [\n {\n \"id\": \"\"\n },\n {\n \"id\": \"\"\n }\n ],\n \"cards\": [\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n },\n {\n \"id\": \"\",\n \"contentType\": \"application/vnd.microsoft.card.adaptive\",\n \"content\": {},\n \"actionSubmitted\": \"\",\n \"actionExecuted\": \"\"\n }\n ]\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chat-gateway/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "chat-gateway", "v1", "conversations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-de4f5937-8dc9-4c43-bc03-f8180dd54b89" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8cedeed2-0c9a-4fa4-8676-cbab8030d51d" } ], "id": "0accb452-1d5a-4bfe-9c7f-b3b6886fc9b4", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0accb452-1d5a-4bfe-9c7f-b3b6886fc9b4" } ], "id": "5ca1c361-1d4f-4145-bafb-d542cef4acc3", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5ca1c361-1d4f-4145-bafb-d542cef4acc3" } ], "id": "478328fb-3c05-481d-94f8-0628c523cf2c", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-478328fb-3c05-481d-94f8-0628c523cf2c" }, { "name": "api", "item": [ { "name": "v1", "item": [ { "name": "tenant", "item": [ { "name": "{tenantId}", "item": [ { "name": "conversations", "item": [ { "name": "{conversationId}", "item": [ { "name": "cards", "item": [ { "name": "{cardId}", "item": [ { "name": "action-submit", "item": [ { "name": "Sends the adaptive card action submit.", "id": "aa9ec32a-05e7-49ff-9cef-7a8294d75496", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "id": "aa3a7f8e-0de8-4257-9d4e-c0a4a5aca038", "key": "tenantId", "value": "", "description": "(Required) Tenant identifier." }, { "id": "ea27691f-2bdb-4d29-8afe-9174693c766e", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." }, { "id": "44cb4758-6795-4fac-8d6c-b2e13c046c40", "key": "cardId", "value": "", "description": "(Required) Card identifier." } ] }, "description": "Updates the adaptive card action submit flag and sends the activity notification." }, "response": [ { "id": "0dcf264a-cb27-433d-b046-491b2386d60a", "name": "Adaptive card action.submit was updated successfully and the notification was sent.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0dcf264a-cb27-433d-b046-491b2386d60a" }, { "id": "4b0ea472-da3d-4d22-bc0c-82fb19ee9bbb", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4b0ea472-da3d-4d22-bc0c-82fb19ee9bbb" }, { "id": "94f62e71-1207-4221-b38a-db1523b4721e", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-94f62e71-1207-4221-b38a-db1523b4721e" }, { "id": "021408e5-c796-42b9-9882-f41032553e19", "name": "Contains a descriptive response.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-021408e5-c796-42b9-9882-f41032553e19" }, { "id": "8e914c20-7ac4-4298-9d8c-619b7c770540", "name": "Contains a descriptive information.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-8e914c20-7ac4-4298-9d8c-619b7c770540" }, { "id": "ebdabf45-3522-4060-a252-58fc9ed278ce", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ebdabf45-3522-4060-a252-58fc9ed278ce" }, { "id": "d0289d01-2fed-4c7f-9fd8-3c64b50a4931", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-submit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-submit" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-d0289d01-2fed-4c7f-9fd8-3c64b50a4931" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-aa9ec32a-05e7-49ff-9cef-7a8294d75496" } ], "id": "de425b0c-640a-4717-97b7-c5a4a6ff4577", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-de425b0c-640a-4717-97b7-c5a4a6ff4577" }, { "name": "action-execute", "item": [ { "name": "Sends the adaptive card action execute.", "id": "617be554-1aa8-4fa4-8f55-0994f60d8f79", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "id": "4d68bcd9-b554-45b1-aab6-96853496c149", "key": "tenantId", "value": "", "description": "(Required) Tenant identifier." }, { "id": "0a6702a9-b329-49da-a2ad-4ab461375245", "key": "conversationId", "value": "", "description": "(Required) Conversation identifier." }, { "id": "e8f48a5d-a0f2-4e6d-8f07-42b8b5230d7f", "key": "cardId", "value": "", "description": "(Required) Card identifier." } ] }, "description": "Updates the adaptive card action execute flag and sends the activity notification." }, "response": [ { "id": "2324618f-3705-4d4e-8fa8-51bb20419d0c", "name": "Adaptive card action.execute was updated successfully and the notification was sent.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-2324618f-3705-4d4e-8fa8-51bb20419d0c" }, { "id": "22eb5899-d134-4c04-aefb-3ce6884b44fe", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-22eb5899-d134-4c04-aefb-3ce6884b44fe" }, { "id": "e7c34753-2656-4504-a608-abbf03b6e77f", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"message\": \"\",\n \"code\": \"\"\n },\n {\n \"message\": \"\",\n \"code\": \"\"\n }\n ],\n \"referenceId\": \"\"\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-e7c34753-2656-4504-a608-abbf03b6e77f" }, { "id": "cdbc3d45-c722-432b-b7d0-7701d2477b7d", "name": "Contains a descriptive response.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-cdbc3d45-c722-432b-b7d0-7701d2477b7d" }, { "id": "bcd0a027-6c93-439f-8e81-e8ba109fbfa7", "name": "Contains a descriptive information.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-bcd0a027-6c93-439f-8e81-e8ba109fbfa7" }, { "id": "56b16c5f-2974-41b0-b12d-03bd6bb02a5e", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-56b16c5f-2974-41b0-b12d-03bd6bb02a5e" }, { "id": "0b9c340d-cecc-4319-b848-df15661c85d9", "name": "Contains a description of the error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v1/tenant/:tenantId/conversations/:conversationId/cards/:cardId/action-execute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "tenant", ":tenantId", "conversations", ":conversationId", "cards", ":cardId", "action-execute" ], "variable": [ { "key": "tenantId" }, { "key": "conversationId" }, { "key": "cardId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n },\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-0b9c340d-cecc-4319-b848-df15661c85d9" } ], "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-617be554-1aa8-4fa4-8f55-0994f60d8f79" } ], "id": "4d91abfe-05f3-432b-9bde-b2dffad6c04c", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-4d91abfe-05f3-432b-9bde-b2dffad6c04c" } ], "id": "5418f98e-f28b-4075-a944-b1c69ff977e5", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-5418f98e-f28b-4075-a944-b1c69ff977e5" } ], "id": "09cedc9f-0c97-4a7f-9a5f-72bf536ceceb", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-09cedc9f-0c97-4a7f-9a5f-72bf536ceceb" } ], "id": "c525f4a9-91f5-4a44-ba6d-1063839a7d02", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-c525f4a9-91f5-4a44-ba6d-1063839a7d02" } ], "id": "71693b20-9c93-4277-afc7-423559e83e2a", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-71693b20-9c93-4277-afc7-423559e83e2a" } ], "id": "dde34b3e-6c53-408f-8b58-01c5d022c06c", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-dde34b3e-6c53-408f-8b58-01c5d022c06c" } ], "id": "ca40ed87-1d56-478c-97e0-17efc5ad1f4d", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-ca40ed87-1d56-478c-97e0-17efc5ad1f4d" } ], "id": "aaa450ba-b48b-4221-8ace-237f1d0f433a", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-aaa450ba-b48b-4221-8ace-237f1d0f433a" } ], "id": "79705804-6457-4ca8-ac56-4634462d9e8e", "createdAt": "2026-07-28T00:27:06.000Z", "updatedAt": "2026-07-28T00:27:06.000Z", "uid": "35240-79705804-6457-4ca8-ac56-4634462d9e8e" } ], "variable": [ { "key": "baseUrl", "value": "https://api.8x8.com" } ] }