{ "item": [ { "id": "b5ba8932-4326-4f7d-bf5c-845751c35be5", "name": "Contas", "description": { "content": "Account management APIs", "type": "text/plain" }, "item": [ { "id": "8c1a4f9b-1cad-454d-a5a8-994f6b3a28e7", "name": "Create an Account", "request": { "name": "Create an Account", "description": { "content": "Create an Account", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7f0dbe28-e25a-4306-bc3c-21f31111dfc7", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1795.8480862574033,\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893febc2-6ca7-4778-8ca3-1c441c5d1bb5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c2f74b7-b1ce-4744-bc3e-fb17434d962b", "name": "Get an account details", "request": { "name": "Get an account details", "description": { "content": "Get the details of an account", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6437cf7b-6636-48de-9f41-d0d258f887ad", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1795.8480862574033,\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b064cbe8-2594-4925-8b0e-01fcfd27f322", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "744fdb69-e684-447a-ba5c-51f33db32af7", "name": "The given account does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef0ed776-8f4c-494b-b34d-06079795a5ad", "name": "Update an account", "request": { "name": "Update an account", "description": { "content": "Update an account's attributes", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "44fc932f-671f-4de5-83d5-33c18f1da657", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1795.8480862574033,\n \"name\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a7abbff-90ae-43ab-a755-d09dade22f9c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Account\",\n \"locale\": \"en\",\n \"domain\": \"example.com\",\n \"support_email\": \"support@example.com\",\n \"status\": \"active\",\n \"limits\": {},\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a851e8c-23d1-41df-bbe6-6cb07e446dcd", "name": "Delete an Account", "request": { "name": "Delete an Account", "description": { "content": "Delete an Account", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c28d85ea-8f1b-4644-b139-f9dbb6b8a91f", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3e04ca9e-659c-41c3-84d7-6d7a71574d9b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3903cbc5-b613-4c72-8eb3-68ba9230f159", "name": "The account does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "769e3048-aebf-46f6-b4dd-2a98f7774641", "name": "Usuários da Conta", "description": { "content": "Account user management APIs", "type": "text/plain" }, "item": [ { "id": "7623d2a5-692a-4ea2-92a1-320e00e6859c", "name": "List all Account Users", "request": { "name": "List all Account Users", "description": { "content": "List all account users", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8563f5e3-842c-4f35-89bc-f8de15a56d7c", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"account_id\": 1937,\n \"user_id\": 6430,\n \"role\": \"string\"\n },\n {\n \"account_id\": 9001,\n \"user_id\": 6715,\n \"role\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ded84a-55a3-466b-97f8-09b4f0996d93", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53141b83-4df0-44ea-b1f8-78f81275b6c6", "name": "Create an Account User", "request": { "name": "Create an Account User", "description": { "content": "Create an Account User", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"role\": \"administrator\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de178644-62c4-4650-aea1-8d0ce4b3a288", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"role\": \"administrator\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"account_id\": 5559,\n \"user_id\": 3227,\n \"role\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39d20017-94c5-4772-b4e8-a5fc23a05a3c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"role\": \"administrator\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0aeddd9e-21cb-4256-8e5b-43f53740b7db", "name": "Delete an Account User", "request": { "name": "Delete an Account User", "description": { "content": "Delete an Account User", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "370a3c76-6cc1-4eb7-abb2-8de088213d88", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4c4b15b6-14ac-49ce-b26f-4ff19b9d9210", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82ee56b7-2420-4844-8520-6af962565c18", "name": "The account does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "accounts", ":account_id", "account_users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f28ec0e0-f904-4088-bcb8-d04d5919608a", "name": "Bots", "description": { "content": "Bot integrations", "type": "text/plain" }, "item": [ { "id": "1ab023d6-21e2-40f3-b5db-af74a65f265a", "name": "List all AgentBots", "request": { "name": "List all AgentBots", "description": { "content": "List all agent bots available", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d7728ef9-2788-4659-8fe5-803099c50186", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 4968.137060532017,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 1979.4679951453077,\n \"access_token\": \"string\",\n \"system_bot\": false\n },\n {\n \"id\": 1855.0029616109875,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 201.45486761444232,\n \"access_token\": \"string\",\n \"system_bot\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c62d058-4303-4663-8f2d-86395f7fcaa2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e183ccb-52a6-4132-a7e5-e82af9900d72", "name": "Create an Agent Bot", "request": { "name": "Create an Agent Bot", "description": { "content": "Create an agent bot", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "54e1d96a-58c6-48a2-92c6-c5b82d5b74f9", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81f9a933-ea51-4cdd-8905-d2e1d9c54a27", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b4a8204-e145-412f-b15e-2f1d7f24d460", "name": "Get an agent bot details", "request": { "name": "Get an agent bot details", "description": { "content": "Get the details of an agent bot", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e2d7cfd3-c225-4a7c-a7b7-0838d4d871a2", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb0c1f4f-8dde-453f-af7d-999d9d1cf2c5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4af42464-b18f-4a25-8c84-af535902c113", "name": "The given agent bot ID does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "25fa1dee-753c-453a-b62c-ae5f181459b7", "name": "Update an agent bot", "request": { "name": "Update an agent bot", "description": { "content": "Update an agent bot's attributes", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bd52af2d-2733-4fd6-8922-8129a114315a", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ef2d5a-0de1-4f38-b8c6-c37417c0a9d2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2228927f-faf7-4c7a-8752-d6a869a28cfd", "name": "Delete an AgentBot", "request": { "name": "Delete an AgentBot", "description": { "content": "Delete an AgentBot", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "196db76a-ca69-49df-8061-5ef142de18f9", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "935b5e81-8a3c-4ed7-90c1-4c6180090a68", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "997cac9e-9af6-4198-998c-5eac1ba59686", "name": "The agent bot does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8dc74ac2-62b2-47c1-8a8d-9116714bb0cb", "name": "Usuários", "description": { "content": "User management APIs", "type": "text/plain" }, "item": [ { "id": "e368a65c-848b-45be-82bb-debd4043de5e", "name": "Create a User", "request": { "name": "Create a User", "description": { "content": "Create a User", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5fd515fe-0e10-482d-8e9b-9bb358f07338", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7237.310213406425,\n \"access_token\": \"string\",\n \"account_id\": 4638.764954287752,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": false,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 3975.124863134112,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"agent\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"id\": 5501.78802371852,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"2017-01-17T05:24:53.763Z\",\n \"role\": \"administrator\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": true,\n \"custom_role_id\": 938.0727679900269,\n \"custom_role\": {}\n },\n {\n \"id\": 1284.0487681288525,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"1986-02-10T13:07:39.685Z\",\n \"role\": \"agent\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": false,\n \"custom_role_id\": 2941.4028021661798,\n \"custom_role\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4aaf228-460e-46c1-a8b6-1d398913f91e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a846c5a6-e779-4450-a6a9-5b611d994671", "name": "Get an user details", "request": { "name": "Get an user details", "description": { "content": "Get the details of an user", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3cb852a2-5a69-48fd-9814-ece97ccc5340", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7237.310213406425,\n \"access_token\": \"string\",\n \"account_id\": 4638.764954287752,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": false,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 3975.124863134112,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"agent\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"id\": 5501.78802371852,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"2017-01-17T05:24:53.763Z\",\n \"role\": \"administrator\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": true,\n \"custom_role_id\": 938.0727679900269,\n \"custom_role\": {}\n },\n {\n \"id\": 1284.0487681288525,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"1986-02-10T13:07:39.685Z\",\n \"role\": \"agent\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": false,\n \"custom_role_id\": 2941.4028021661798,\n \"custom_role\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a25fd94-4227-41e2-99d6-5e5fb8e2a0ea", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "933d4d3b-f27d-46e0-9bb4-bea92a58cc8b", "name": "The given user does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a356f41d-bc58-4f67-bcb4-6ab0c4d8b8fc", "name": "Update a user", "request": { "name": "Update a user", "description": { "content": "Update a user's attributes", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a67d3249-44c1-404f-bd8b-fcecd6478a50", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7237.310213406425,\n \"access_token\": \"string\",\n \"account_id\": 4638.764954287752,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": false,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 3975.124863134112,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"agent\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"id\": 5501.78802371852,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"2017-01-17T05:24:53.763Z\",\n \"role\": \"administrator\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": true,\n \"custom_role_id\": 938.0727679900269,\n \"custom_role\": {}\n },\n {\n \"id\": 1284.0487681288525,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"1986-02-10T13:07:39.685Z\",\n \"role\": \"agent\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": false,\n \"custom_role_id\": 2941.4028021661798,\n \"custom_role\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79787492-d2c8-4312-8bc1-1dadf3ced321", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Daniel\",\n \"display_name\": \"Dan\",\n \"email\": \"daniel@acme.inc\",\n \"password\": \"Password2!\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c717e08f-54e4-4aba-9b65-40f0b076a33c", "name": "Delete a User", "request": { "name": "Delete a User", "description": { "content": "Delete a User", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "cbfe587d-cbc2-45e7-9978-9c51507bf6f5", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "deee76b0-a39e-4ab4-abb7-d523ebadb788", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8e348c6-a923-458b-8bbf-2fdf4776bca9", "name": "The user does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1061dff2-561a-4985-8987-8319b5ec7fc1", "name": "Get User SSO Link", "request": { "name": "Get User SSO Link", "description": { "content": "Get the sso link of a user", "type": "text/plain" }, "url": { "path": [ "platform", "api", "v1", "users", ":id", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "84e2b812-b58d-4c64-9a0d-8af3304440b5", "name": "Success", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"url\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4229b01a-2a67-4a34-8a90-713af0e5790b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "456ab8ef-0116-49e6-8c83-3e4714c31ba4", "name": "The given user does not exist", "originalRequest": { "url": { "path": [ "platform", "api", "v1", "users", ":id", "login" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The numeric ID of the user on the platform" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6ee89240-21fa-43e4-bd8b-1999d43dae75", "name": "Bots da Conta", "description": { "content": "Account-specific Agent Bots", "type": "text/plain" }, "item": [ { "id": "9686e1b2-b395-4ffb-b38a-9c9205bfebe1", "name": "List all AgentBots", "request": { "name": "List all AgentBots", "description": { "content": "List all agent bots available for the current account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3865c98e-19fe-40dd-bf68-04029ae75da9", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 4968.137060532017,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 1979.4679951453077,\n \"access_token\": \"string\",\n \"system_bot\": false\n },\n {\n \"id\": 1855.0029616109875,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 201.45486761444232,\n \"access_token\": \"string\",\n \"system_bot\": false\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0560985e-65d4-436c-85a4-89c5d9dca526", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a20d24b-c1cb-469d-b3f9-2b3b0ac18f8b", "name": "Create an Agent Bot", "request": { "name": "Create an Agent Bot", "description": { "content": "Create an agent bot in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b9a23b85-f2b0-4462-a3db-eb31dd3f88b1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b610553c-0bc6-4a04-80ea-2beea94b1847", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0313e06-7196-4fb1-ba3e-2d2333348a22", "name": "Get an agent bot details", "request": { "name": "Get an agent bot details", "description": { "content": "Get the details of an agent bot in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0c4a1455-88a5-4f7b-b8b1-0f9f669c035e", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2eec5d89-1caf-47e6-9c1b-2feb498fc46c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "707a87cb-8370-4d3e-941e-c47a003e9b3f", "name": "The given agent bot ID does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee4cc121-e791-4e63-a48f-19088b7e2cf6", "name": "Update an agent bot", "request": { "name": "Update an agent bot", "description": { "content": "Update an agent bot's attributes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3779f984-548a-4acd-b2bf-3b4f44f165ec", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee7736aa-ca48-4560-8e8a-29554a47b6d7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"bot_type\": 0,\n \"bot_config\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20fee0bd-7a63-46d7-a241-0cbca14e5f97", "name": "Delete an AgentBot", "request": { "name": "Delete an AgentBot", "description": { "content": "Delete an AgentBot from the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a0b4d15f-ef22-405a-8feb-aaa33e2cbc61", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8151e6e9-8ab8-4057-91f2-a22f877d34b1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b8f5700-7d0d-44cf-90be-3a874fcd7241", "name": "The agent bot does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agent_bots", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agentbot to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "dd3ef71c-e58a-450f-8393-8fbf21978004", "name": "Agentes", "description": { "content": "Agent management APIs", "type": "text/plain" }, "item": [ { "id": "850a1614-a7b9-4b37-951d-44b0510e4e95", "name": "List Agents in Account", "request": { "name": "List Agents in Account", "description": { "content": "Get Details of Agents in an Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fce57963-dcf8-41fd-b9fa-d5ede692e07b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 7780,\n \"account_id\": 6160,\n \"availability_status\": \"available\",\n \"auto_offline\": true,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 3510\n },\n {\n \"id\": 1734,\n \"account_id\": 9767,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 4998\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c066e24f-da8f-45fc-934a-cdd4587af00c", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eecc1998-cfc2-49aa-b5f1-159d4305798c", "name": "Add a New Agent", "request": { "name": "Add a New Agent", "description": { "content": "Add a new Agent to Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@acme.inc\",\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a0a371d8-6bbb-4c7b-8ef7-76c8712698de", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@acme.inc\",\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2734,\n \"account_id\": 9876,\n \"availability_status\": \"busy\",\n \"auto_offline\": false,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"agent\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 4226\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b1dabb5-2e8d-4016-8e24-d353fb22b0cd", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"John Doe\",\n \"email\": \"john.doe@acme.inc\",\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1195b5ab-610b-420c-981e-a462796d14e0", "name": "Update Agent in Account", "request": { "name": "Update Agent in Account", "description": { "content": "Update an Agent in Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "74dda732-836c-4b1e-ba0e-9885150e267e", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2734,\n \"account_id\": 9876,\n \"availability_status\": \"busy\",\n \"auto_offline\": false,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"agent\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 4226\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df934798-f9d6-45fd-bad0-ed302fa76439", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a516a52-28df-4503-85b5-435d4477c431", "name": "Agent not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e034751-518c-4c43-881f-53a63847d0f2", "name": "Remove an Agent from Account", "request": { "name": "Remove an Agent from Account", "description": { "content": "Remove an Agent from Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be deleted." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "792d60ed-2e60-4432-9bdc-ca98a8b1503b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be deleted." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e51e2619-6ad6-4c40-9947-783100fecf91", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be deleted." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7832823-a514-444c-b2da-dec162512573", "name": "Agent not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the agent to be deleted." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f17b268e-6e14-49c4-982e-caa4a0c12307", "name": "Respostas Prontas", "description": { "content": "Pre-defined responses for common queries", "type": "text/plain" }, "item": [ { "id": "f76e4b94-bdd9-4841-ae11-c4e3e0cefd40", "name": "List all Canned Responses in an Account", "request": { "name": "List all Canned Responses in an Account", "description": { "content": "Get Details of Canned Responses in an Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "1a6c5503-8e8d-4769-bbfc-80835576a3a1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 938,\n \"account_id\": 9620,\n \"short_code\": \"string\",\n \"content\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n {\n \"id\": 7580,\n \"account_id\": 3674,\n \"short_code\": \"string\",\n \"content\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4063c0e-1298-4acc-82b1-1a9432c4bdc9", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a09bbd96-dde1-4255-80dd-900ea5984455", "name": "Add a New Canned Response", "request": { "name": "Add a New Canned Response", "description": { "content": "Add a new Canned Response to Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cff877b1-6983-4ac1-be34-3f998b5f4c69", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2816,\n \"account_id\": 6498,\n \"short_code\": \"string\",\n \"content\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e103750-6128-47af-be07-9d2c218593b6", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e904970-0458-4d84-9b26-d8446933850d", "name": "Update Canned Response in Account", "request": { "name": "Update Canned Response in Account", "description": { "content": "Update a Canned Response in Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ba4f2d1b-287c-4d8a-9da4-bfa061a90722", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2816,\n \"account_id\": 6498,\n \"short_code\": \"string\",\n \"content\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "991c3d53-5542-484b-902c-17ea2b65a60a", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d042d569-6f49-4e67-95cc-2029a1c373b5", "name": "Agent not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, {{contact.name}}! Welcome to our service.\",\n \"short_code\": \"welcome\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "051160b1-e2df-4e2c-bfdd-fddb0676ba52", "name": "Remove a Canned Response from Account", "request": { "name": "Remove a Canned Response from Account", "description": { "content": "Remove a Canned Response from Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "42a07524-154d-4092-ab38-c9f5e839c68c", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12f622a8-5a7c-48a8-909c-3ee969a371fe", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20111abd-ee1b-4403-901a-e15055386ff6", "name": "Canned Response not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "canned_responses", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the canned response to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a56d739f-ce77-4893-8839-93c7cf0a3538", "name": "Contatos", "description": { "content": "Contact management APIs", "type": "text/plain" }, "item": [ { "id": "37381270-9906-45b8-887e-a3442ecb2770", "name": "List Contacts", "request": { "name": "List Contacts", "description": { "content": "Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "sort", "value": "-name", "description": "The attribute by which list should be sorted" }, { "disabled": false, "key": "page", "value": "1", "description": "The page parameter" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0441b25f-076f-45a0-a400-bf4d1f1c73da", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "-name" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"count\": 6388,\n \"current_page\": \"string\"\n },\n \"payload\": [\n {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"offline\",\n \"email\": \"string\",\n \"id\": 1468,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 6081,\n \"created_at\": 7520,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"online\",\n \"email\": \"string\",\n \"id\": 3386,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 9193,\n \"created_at\": 6798,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a06c25-e668-4ad0-82cb-14c880798d37", "name": "Bad Request Error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "sort", "value": "-name" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3e82ab1-5d56-434a-b241-9a6a4fabaa44", "name": "Create Contact", "request": { "name": "Create Contact", "description": { "content": "Create a new Contact", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "865e9a7a-f153-43b4-9549-beae6711ce26", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 3464,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"signed_up_at\": \"dd/mm/yyyy\"\n },\n \"last_activity_at\": 3391,\n \"created_at\": 1438,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 6785,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"signed_up_at\": \"dd/mm/yyyy\"\n },\n \"last_activity_at\": 8785,\n \"created_at\": 6885,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"id\": 7636.843231275311,\n \"availability_status\": \"offline\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a74152d7-9fa3-494f-8af8-f623d2f4ca5b", "name": "Bad Request Error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8749ce8e-be65-4f3b-9842-d39295ae3cca", "name": "Show Contact", "request": { "name": "Show Contact", "description": { "content": "Get a contact belonging to the account using ID", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f1450567-8e46-401f-b1a9-ea1076aeaf65", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"offline\",\n \"email\": \"string\",\n \"id\": 6248,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 6874,\n \"created_at\": 4068,\n \"contact_inboxes\": [\n {\n \"source_id\": {\n \"value\": \"\"\n },\n \"inbox\": {\n \"value\": \"\"\n }\n },\n {\n \"source_id\": {\n \"value\": \"\"\n },\n \"inbox\": {\n \"value\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee231499-4f99-49af-8e9f-3b5e5e9fbbf3", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15739a44-3e0f-4b12-9b7e-6014fb4cd5be", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "76e07493-0702-46a4-a8d7-e73a0b8d0a03", "name": "Update Contact", "request": { "name": "Update Contact", "description": { "content": "Update a contact belonging to the account using ID", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b3440e1d-c2e4-4277-be62-f0132609c1d6", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1821.3550429119696,\n \"payload\": [\n {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 371,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": true,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"signed_up_at\": \"dd/mm/yyyy\"\n },\n \"last_activity_at\": 3985,\n \"created_at\": 6639,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 1565,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": true,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"signed_up_at\": \"dd/mm/yyyy\"\n },\n \"last_activity_at\": 6727,\n \"created_at\": 3702,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da5fb6f0-ef8d-455d-9002-5b9083d6f0ad", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9ddf073-8ac6-4381-b2d9-e09900d4532c", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"identifier\": \"1234567890\",\n \"additional_attributes\": {\n \"type\": \"customer\",\n \"age\": 30\n },\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1510ac70-693f-4944-ac5a-de2dc4705d71", "name": "Delete Contact", "request": { "name": "Delete Contact", "description": { "content": "Delete a contact belonging to the account using ID", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fd7544a7-2651-450e-b5b5-e107279709f1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ed2a1199-9cbb-4a87-adb8-a17075d79977", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cbb79ae-6ba0-441c-9d1a-36ea27da7bd6", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "808f4606-9539-4c6b-b2c0-63be0483e1ce", "name": "Contact Conversations", "request": { "name": "Contact Conversations", "description": { "content": "Get conversations associated with that contact", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "69ba2c45-6b86-454d-b785-41f3a6dea63b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 3994.3567890365816,\n \"messages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": 5310.956040646156,\n \"uuid\": \"string\",\n \"additional_attributes\": {},\n \"agent_last_seen_at\": 7717.798144360433,\n \"assignee_last_seen_at\": 9719.60251580902,\n \"can_reply\": true,\n \"contact_last_seen_at\": 1235.3663026606941,\n \"custom_attributes\": {},\n \"inbox_id\": 7189.483204326589,\n \"labels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"muted\": false,\n \"snoozed_until\": 526.7457983898461,\n \"status\": \"open\",\n \"created_at\": 2624.3379360738363,\n \"updated_at\": 6318.093536868069,\n \"timestamp\": 2478.4830064574417,\n \"first_reply_created_at\": 546.7500536060854,\n \"unread_count\": 9898.238976048679,\n \"last_non_activity_message\": {\n \"value\": \"\"\n },\n \"last_activity_at\": 9009.058426286136,\n \"priority\": \"string\",\n \"waiting_since\": 4588.029475106309,\n \"sla_policy_id\": 786.2493724393482,\n \"applied_sla\": {},\n \"sla_events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"sender\": {\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n \"channel\": \"string\",\n \"assignee\": {\n \"value\": \"\"\n },\n \"hmac_verified\": true\n }\n },\n {\n \"id\": 3732.212215290398,\n \"messages\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"account_id\": 8554.78605509251,\n \"uuid\": \"string\",\n \"additional_attributes\": {},\n \"agent_last_seen_at\": 1957.6233424961586,\n \"assignee_last_seen_at\": 334.7176685360431,\n \"can_reply\": false,\n \"contact_last_seen_at\": 4410.2527512043525,\n \"custom_attributes\": {},\n \"inbox_id\": 4305.443080518284,\n \"labels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"muted\": true,\n \"snoozed_until\": 3197.0211950204007,\n \"status\": \"open\",\n \"created_at\": 4945.224663727022,\n \"updated_at\": 4951.799988371038,\n \"timestamp\": 434.95466868310626,\n \"first_reply_created_at\": 395.7079215306658,\n \"unread_count\": 7571.998460888002,\n \"last_non_activity_message\": {\n \"value\": \"\"\n },\n \"last_activity_at\": 314.0951840725004,\n \"priority\": \"string\",\n \"waiting_since\": 3478.6076667287157,\n \"sla_policy_id\": 8353.004614869493,\n \"applied_sla\": {},\n \"sla_events\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"meta\": {\n \"sender\": {\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n \"channel\": \"string\",\n \"assignee\": {\n \"value\": \"\"\n },\n \"hmac_verified\": true\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87c9cba0-6e37-4e2c-806c-5b2a4af1423c", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "709e67e0-f983-4d5e-8dad-45e2b1ec5ec0", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5d5c738-d0ca-465a-9056-8d51dfeae6f8", "name": "Search Contacts", "request": { "name": "Search Contacts", "description": { "content": "Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "string", "description": "Search using contact `name`, `identifier`, `email` or `phone number`" }, { "disabled": false, "key": "sort", "value": "-name", "description": "The attribute by which list should be sorted" }, { "disabled": false, "key": "page", "value": "1", "description": "The page parameter" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0d8a7016-ff64-4d31-99fe-6f81951dd563", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "sort", "value": "-name" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"count\": 6388,\n \"current_page\": \"string\"\n },\n \"payload\": [\n {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"offline\",\n \"email\": \"string\",\n \"id\": 1468,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 6081,\n \"created_at\": 7520,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"online\",\n \"email\": \"string\",\n \"id\": 3386,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 9193,\n \"created_at\": 6798,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2b1a12b-4cfc-42cd-996d-99340039220e", "name": "Authentication error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "q", "value": "string" }, { "key": "sort", "value": "-name" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9aa85e42-ad2c-42d6-8b3c-b556fd7f54eb", "name": "Contact Filter", "request": { "name": "Contact Filter", "description": { "content": "Filter contacts with custom filter options and pagination", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "3074.5223851301052" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"contains\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"contains\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"OR\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de949d49-423e-48cc-8774-b2c16a08d08d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "3074.5223851301052" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"not_equal_to\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"does_not_contain\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"count\": 6388,\n \"current_page\": \"string\"\n },\n \"payload\": [\n {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"offline\",\n \"email\": \"string\",\n \"id\": 1468,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 6081,\n \"created_at\": 7520,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"additional_attributes\": {\n \"city\": \"string\",\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"created_at_ip\": \"string\"\n },\n \"availability_status\": \"online\",\n \"email\": \"string\",\n \"id\": 3386,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": false,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 9193,\n \"created_at\": 6798,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30ebc429-e18d-4114-8eb6-863c43636dba", "name": "Bad Request Error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "3074.5223851301052" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"not_equal_to\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"does_not_contain\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d026c470-3b41-4cbd-961d-fd753a10bd36", "name": "Create contact inbox", "request": { "name": "Create contact inbox", "description": { "content": "Create a contact inbox record for an inbox", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contact_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"source_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "22b35996-7cb5-4a3a-a3d9-5b1badf02d4a", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contact_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"source_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"source_id\": \"string\",\n \"inbox\": {\n \"id\": 7237.818460808364,\n \"avatar_url\": \"string\",\n \"channel_id\": 7472.672013866524,\n \"name\": \"string\",\n \"channel_type\": \"string\",\n \"provider\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "888d05f9-c27b-4776-b344-1898d6aae077", "name": "Authentication error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contact_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"source_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "790baf54-db68-4766-a1b9-f7e471237a4a", "name": "Incorrect payload", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contact_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"source_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54a65aaf-b13a-4566-932b-94dbbaa6e606", "name": "Get Contactable Inboxes", "request": { "name": "Get Contactable Inboxes", "description": { "content": "Get List of contactable Inboxes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contactable_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b3587f3f-a0a6-4f59-9389-c258d0c22bd7", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contactable_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"source_id\": \"string\",\n \"inbox\": {\n \"id\": 7432,\n \"avatar_url\": \"string\",\n \"channel_id\": 1360,\n \"name\": \"string\",\n \"channel_type\": \"string\",\n \"provider\": \"string\"\n }\n },\n {\n \"source_id\": \"string\",\n \"inbox\": {\n \"id\": 6898,\n \"avatar_url\": \"string\",\n \"channel_id\": 3500,\n \"name\": \"string\",\n \"channel_type\": \"string\",\n \"provider\": \"string\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "781f70e4-2efd-49a4-b013-70dc1ad9bd0a", "name": "Authentication error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contactable_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69370d80-2553-41ed-9f59-558d361ced71", "name": "Incorrect payload", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contactable_inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc716fdd-7b45-4612-bbc8-3af0428cd7a9", "name": "Merge Contacts", "request": { "name": "Merge Contacts", "description": { "content": "Merge two contacts into a single contact. The base contact remains and receives all\ndata from the mergee contact. After the merge, the mergee contact is permanently deleted.\n\nThis action is irreversible. All conversations, labels, and custom attributes from the\nmergee contact will be moved to the base contact.\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "actions", "contact_merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"base_contact_id\": 1,\n \"mergee_contact_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5fb9a8e-f4ea-425f-a496-ff8bdaccbe17", "name": "Contacts merged successfully", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "actions", "contact_merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base_contact_id\": 1,\n \"mergee_contact_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1821.3550429119696,\n \"payload\": [\n {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 371,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": true,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"signed_up_at\": \"dd/mm/yyyy\"\n },\n \"last_activity_at\": 3985,\n \"created_at\": 6639,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 1565,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": true,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"signed_up_at\": \"dd/mm/yyyy\"\n },\n \"last_activity_at\": 6727,\n \"created_at\": 3702,\n \"contact_inboxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aad5b244-8f28-420f-a16e-d998bb147c18", "name": "Bad request - invalid contact IDs or contacts cannot be merged", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "actions", "contact_merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base_contact_id\": 1,\n \"mergee_contact_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153ebf0a-8950-40e5-8f60-89fc3e015bec", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "actions", "contact_merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base_contact_id\": 1,\n \"mergee_contact_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f994ac9f-1318-4744-8932-3b939a9437c0", "name": "One or both contacts not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "actions", "contact_merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"base_contact_id\": 1,\n \"mergee_contact_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0e45a098-6e9b-4c02-82d9-88d5756aa141", "name": "Etiquetas de Contato", "description": { "content": "Manage contact labels", "type": "text/plain" }, "item": [ { "id": "8c9d7ad4-7225-4be6-82f6-6c6a5e1028d6", "name": "List Labels", "request": { "name": "List Labels", "description": { "content": "Lists all the labels of a contact", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "90848116-002c-4f22-983a-03b476e63e75", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c509752-565f-4910-908d-f6e6c8686d92", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ccd8f0-fda0-4a7a-bec8-657bd3065277", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce5ceeac-a28e-4cb1-ae27-ece3676544dd", "name": "Add Labels", "request": { "name": "Add Labels", "description": { "content": "Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ddcbc0b8-47f2-4c8d-9f78-873d5b1bb858", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5421a10b-3825-4fa7-a2a6-10ac8605e0c1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0fcc81d-3f00-4e63-8863-f741f0c32ace", "name": "Contact not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the contact" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d2250a6d-93c6-40d5-954d-8cf3669fc1f3", "name": "Atribuição de Conversas", "description": { "content": "Manage conversation assignments", "type": "text/plain" }, "item": [ { "id": "95c4f060-0e4b-43f8-866d-5128920cc1f4", "name": "Assign Conversation", "request": { "name": "Assign Conversation", "description": { "content": "Assign a conversation to an agent or a team", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"assignee_id\": 1,\n \"team_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "98cc2f2f-6ea6-4bc8-ab33-b78c85896b7c", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assignee_id\": 1,\n \"team_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7237.310213406425,\n \"access_token\": \"string\",\n \"account_id\": 4638.764954287752,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": false,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 3975.124863134112,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"agent\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"id\": 5501.78802371852,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"2017-01-17T05:24:53.763Z\",\n \"role\": \"administrator\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": true,\n \"custom_role_id\": 938.0727679900269,\n \"custom_role\": {}\n },\n {\n \"id\": 1284.0487681288525,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"1986-02-10T13:07:39.685Z\",\n \"role\": \"agent\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": false,\n \"custom_role_id\": 2941.4028021661798,\n \"custom_role\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bc8d778-f0f6-4918-a25a-901613a0373e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assignee_id\": 1,\n \"team_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2f24c1a-3fd1-49f6-af11-5d7920431342", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assignee_id\": 1,\n \"team_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5bb9ed07-5326-4522-9893-f8e98890a5e8", "name": "Etiquetas de Conversa", "description": { "content": "Manage conversation labels", "type": "text/plain" }, "item": [], "event": [] }, { "id": "696a92d3-2484-452f-b5ba-71956979b8e8", "name": "Conversas", "description": { "content": "Conversation management APIs", "type": "text/plain" }, "item": [ { "id": "44ffd879-c8f2-4e12-8e95-1cadd2ea91d5", "name": "Get Conversation Counts", "request": { "name": "Get Conversation Counts", "description": { "content": "Get open, unassigned and all Conversation counts", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "open", "description": "Filter by conversation status." }, { "disabled": false, "key": "q", "value": "string", "description": "Filters conversations with messages containing the search term" }, { "disabled": false, "key": "inbox_id", "value": "4630" }, { "disabled": false, "key": "team_id", "value": "4630" }, { "disabled": false, "key": "labels", "value": "string" }, { "disabled": false, "key": "labels", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3604cbbf-5609-49ae-9638-d31a07da4fb5", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "open" }, { "key": "q", "value": "string" }, { "key": "inbox_id", "value": "4630" }, { "key": "team_id", "value": "4630" }, { "key": "labels", "value": "string" }, { "key": "labels", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"mine_count\": 4464.315867243152,\n \"unassigned_count\": 9789.961898874346,\n \"assigned_count\": 3103.7967635668774,\n \"all_count\": 1048.6743647102915\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aab23184-22cd-4cfb-bfdc-4d23b6256c3f", "name": "Bad Request Error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", "meta" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "open" }, { "key": "q", "value": "string" }, { "key": "inbox_id", "value": "4630" }, { "key": "team_id", "value": "4630" }, { "key": "labels", "value": "string" }, { "key": "labels", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c1973c7-c961-4fb8-9ac8-e72ac994c2f6", "name": "Conversations List", "request": { "name": "Conversations List", "description": { "content": "List all the conversations with pagination", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "assignee_type", "value": "all", "description": "Filter conversations by assignee type." }, { "disabled": false, "key": "status", "value": "open", "description": "Filter by conversation status." }, { "disabled": false, "key": "q", "value": "string", "description": "Filters conversations with messages containing the search term" }, { "disabled": false, "key": "inbox_id", "value": "4630" }, { "disabled": false, "key": "team_id", "value": "4630" }, { "disabled": false, "key": "labels", "value": "string" }, { "disabled": false, "key": "labels", "value": "string" }, { "disabled": false, "key": "page", "value": "1", "description": "paginate through conversations" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a6cdb7d0-9461-4026-853f-f7daab767240", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "assignee_type", "value": "all" }, { "key": "status", "value": "open" }, { "key": "q", "value": "string" }, { "key": "inbox_id", "value": "4630" }, { "key": "team_id", "value": "4630" }, { "key": "labels", "value": "string" }, { "key": "labels", "value": "string" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"meta\": {\n \"mine_count\": 8301.156704825176,\n \"unassigned_count\": 8550.595923174942,\n \"assigned_count\": 5503.6234785049755,\n \"all_count\": 9217.779657629197\n },\n \"payload\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"messages\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"agent_last_seen_at\": {\n \"value\": \"\"\n },\n \"assignee_last_seen_at\": {\n \"value\": \"\"\n },\n \"can_reply\": {\n \"value\": \"\"\n },\n \"contact_last_seen_at\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"muted\": {\n \"value\": \"\"\n },\n \"snoozed_until\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"first_reply_created_at\": {\n \"value\": \"\"\n },\n \"unread_count\": {\n \"value\": \"\"\n },\n \"last_non_activity_message\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"waiting_since\": {\n \"value\": \"\"\n },\n \"sla_policy_id\": {\n \"value\": \"\"\n },\n \"applied_sla\": {\n \"value\": \"\"\n },\n \"sla_events\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"sender\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"assignee\": {\n \"value\": \"\"\n },\n \"hmac_verified\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"messages\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"agent_last_seen_at\": {\n \"value\": \"\"\n },\n \"assignee_last_seen_at\": {\n \"value\": \"\"\n },\n \"can_reply\": {\n \"value\": \"\"\n },\n \"contact_last_seen_at\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"muted\": {\n \"value\": \"\"\n },\n \"snoozed_until\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"first_reply_created_at\": {\n \"value\": \"\"\n },\n \"unread_count\": {\n \"value\": \"\"\n },\n \"last_non_activity_message\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"waiting_since\": {\n \"value\": \"\"\n },\n \"sla_policy_id\": {\n \"value\": \"\"\n },\n \"applied_sla\": {\n \"value\": \"\"\n },\n \"sla_events\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"sender\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"assignee\": {\n \"value\": \"\"\n },\n \"hmac_verified\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "317cfcab-ea6d-4bad-b411-352d66032539", "name": "Bad Request Error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "assignee_type", "value": "all" }, { "key": "status", "value": "open" }, { "key": "q", "value": "string" }, { "key": "inbox_id", "value": "4630" }, { "key": "team_id", "value": "4630" }, { "key": "labels", "value": "string" }, { "key": "labels", "value": "string" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5081f1c-b7d8-4936-8e91-b14d940be891", "name": "Create New Conversation", "request": { "name": "Create New Conversation", "description": { "content": "Creating a conversation in SiteUp requires a source id. \n\n Learn more about source_id: https://siteup.com.br", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"source_id\": \"1234567890\",\n \"inbox_id\": 1,\n \"contact_id\": 1,\n \"additional_attributes\": {\n \"browser\": \"Chrome\",\n \"browser_version\": \"89.0.4389.82\",\n \"os\": \"Windows\",\n \"os_version\": \"10\"\n },\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"priority_conversation_number\": 3\n },\n \"status\": \"open\",\n \"assignee_id\": 1,\n \"team_id\": 1,\n \"snoozed_until\": \"2030-07-21T17:32:28Z\",\n \"message\": {\n \"content\": \"Hello, how can I help you?\",\n \"template_params\": {\n \"name\": \"sample_issue_resolution\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"1\": \"SiteUp\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d2e60d5-d6f9-4062-90d6-c44583feae9f", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"1234567890\",\n \"inbox_id\": 1,\n \"contact_id\": 1,\n \"additional_attributes\": {\n \"browser\": \"Chrome\",\n \"browser_version\": \"89.0.4389.82\",\n \"os\": \"Windows\",\n \"os_version\": \"10\"\n },\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"priority_conversation_number\": 3\n },\n \"status\": \"open\",\n \"assignee_id\": 1,\n \"team_id\": 1,\n \"snoozed_until\": \"2030-07-21T17:32:28Z\",\n \"message\": {\n \"content\": \"Hello, how can I help you?\",\n \"template_params\": {\n \"name\": \"sample_issue_resolution\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"1\": \"SiteUp\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 9797.428125096389,\n \"account_id\": 8265.79511681595,\n \"inbox_id\": 2167.779549288089\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5836faa6-9050-4250-84dd-d521d66ba6e7", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"source_id\": \"1234567890\",\n \"inbox_id\": 1,\n \"contact_id\": 1,\n \"additional_attributes\": {\n \"browser\": \"Chrome\",\n \"browser_version\": \"89.0.4389.82\",\n \"os\": \"Windows\",\n \"os_version\": \"10\"\n },\n \"custom_attributes\": {\n \"attribute_key\": \"attribute_value\",\n \"priority_conversation_number\": 3\n },\n \"status\": \"open\",\n \"assignee_id\": 1,\n \"team_id\": 1,\n \"snoozed_until\": \"2030-07-21T17:32:28Z\",\n \"message\": {\n \"content\": \"Hello, how can I help you?\",\n \"template_params\": {\n \"name\": \"sample_issue_resolution\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"1\": \"SiteUp\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "de49c0d9-86ec-43f7-bf8e-f7b2ec54691a", "name": "Conversations Filter", "request": { "name": "Conversations Filter", "description": { "content": "Filter conversations with custom filter options and pagination", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "3074.5223851301052" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"not_equal_to\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"OR\"\n },\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"does_not_contain\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"OR\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "388fd824-f261-49b3-92ac-1e540fea2e66", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "3074.5223851301052" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"not_equal_to\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"contains\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"meta\": {\n \"mine_count\": 8301.156704825176,\n \"unassigned_count\": 8550.595923174942,\n \"assigned_count\": 5503.6234785049755,\n \"all_count\": 9217.779657629197\n },\n \"payload\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"messages\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"agent_last_seen_at\": {\n \"value\": \"\"\n },\n \"assignee_last_seen_at\": {\n \"value\": \"\"\n },\n \"can_reply\": {\n \"value\": \"\"\n },\n \"contact_last_seen_at\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"muted\": {\n \"value\": \"\"\n },\n \"snoozed_until\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"first_reply_created_at\": {\n \"value\": \"\"\n },\n \"unread_count\": {\n \"value\": \"\"\n },\n \"last_non_activity_message\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"waiting_since\": {\n \"value\": \"\"\n },\n \"sla_policy_id\": {\n \"value\": \"\"\n },\n \"applied_sla\": {\n \"value\": \"\"\n },\n \"sla_events\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"sender\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"assignee\": {\n \"value\": \"\"\n },\n \"hmac_verified\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"messages\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"uuid\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"agent_last_seen_at\": {\n \"value\": \"\"\n },\n \"assignee_last_seen_at\": {\n \"value\": \"\"\n },\n \"can_reply\": {\n \"value\": \"\"\n },\n \"contact_last_seen_at\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"muted\": {\n \"value\": \"\"\n },\n \"snoozed_until\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"timestamp\": {\n \"value\": \"\"\n },\n \"first_reply_created_at\": {\n \"value\": \"\"\n },\n \"unread_count\": {\n \"value\": \"\"\n },\n \"last_non_activity_message\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"priority\": {\n \"value\": \"\"\n },\n \"waiting_since\": {\n \"value\": \"\"\n },\n \"sla_policy_id\": {\n \"value\": \"\"\n },\n \"applied_sla\": {\n \"value\": \"\"\n },\n \"sla_events\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"sender\": {\n \"value\": \"\"\n },\n \"channel\": {\n \"value\": \"\"\n },\n \"assignee\": {\n \"value\": \"\"\n },\n \"hmac_verified\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cea931d3-3854-4681-8097-7cd23adc43c0", "name": "Bad Request Error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "3074.5223851301052" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"not_equal_to\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"string\",\n \"filter_operator\": \"contains\",\n \"values\": [\n \"string\",\n \"string\"\n ],\n \"query_operator\": \"AND\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eacca5db-4228-486e-ae9e-3ac43cb1f1b6", "name": "Conversation Details", "request": { "name": "Conversation Details", "description": { "content": "Get all details regarding a conversation with all messages in the conversation", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d39e2353-59e9-4d5d-bacb-df2c7122266d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1015.7695215056151,\n \"messages\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"private\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source_id\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"sender_type\": {\n \"value\": \"\"\n },\n \"sender_id\": {\n \"value\": \"\"\n },\n \"external_source_ids\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"processed_message_content\": {\n \"value\": \"\"\n },\n \"sentiment\": {\n \"value\": \"\"\n },\n \"conversation\": {\n \"value\": \"\"\n },\n \"attachment\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"private\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source_id\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"sender_type\": {\n \"value\": \"\"\n },\n \"sender_id\": {\n \"value\": \"\"\n },\n \"external_source_ids\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"processed_message_content\": {\n \"value\": \"\"\n },\n \"sentiment\": {\n \"value\": \"\"\n },\n \"conversation\": {\n \"value\": \"\"\n },\n \"attachment\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n }\n ],\n \"account_id\": 4577.699191947593,\n \"uuid\": \"string\",\n \"additional_attributes\": {},\n \"agent_last_seen_at\": 9536.28524092147,\n \"assignee_last_seen_at\": 6114.757856855981,\n \"can_reply\": false,\n \"contact_last_seen_at\": 6279.203935048297,\n \"custom_attributes\": {},\n \"inbox_id\": 2788.8144696795835,\n \"labels\": [\n \"string\",\n \"string\"\n ],\n \"muted\": true,\n \"snoozed_until\": 8493.591322668746,\n \"status\": \"pending\",\n \"created_at\": 5761.368986630292,\n \"updated_at\": 9228.450331597061,\n \"timestamp\": 2705.9307940715116,\n \"first_reply_created_at\": 106.24455110111785,\n \"unread_count\": 1903.1206956751057,\n \"last_non_activity_message\": {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"inbox_id\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"updated_at\": {\n \"value\": \"\"\n },\n \"private\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"source_id\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"sender_type\": {\n \"value\": \"\"\n },\n \"sender_id\": {\n \"value\": \"\"\n },\n \"external_source_ids\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"processed_message_content\": {\n \"value\": \"\"\n },\n \"sentiment\": {\n \"value\": \"\"\n },\n \"conversation\": {\n \"value\": \"\"\n },\n \"attachment\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n },\n \"last_activity_at\": 7896.52243292615,\n \"priority\": \"string\",\n \"waiting_since\": 5609.755099314947,\n \"sla_policy_id\": 8137.457887758594,\n \"applied_sla\": {},\n \"meta\": {\n \"sender\": {\n \"additional_attributes\": {},\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"id\": 5469.071170626304,\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"blocked\": true,\n \"identifier\": \"string\",\n \"thumbnail\": \"string\",\n \"custom_attributes\": {},\n \"last_activity_at\": 8101.664745218522,\n \"created_at\": 6622.011926356401\n },\n \"channel\": \"string\",\n \"assignee\": {\n \"id\": 1734.739429385429,\n \"access_token\": \"string\",\n \"account_id\": 2410.902196173702,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": true,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 8900.977816055549,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"administrator\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"hmac_verified\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3551a17b-41de-4de3-bf4d-cded9def505a", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15e5df61-130d-4f6f-a1e1-e70a5283b16b", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92927eda-20af-4a0b-bfaf-2ace8ce6e647", "name": "Update Conversation", "request": { "name": "Update Conversation", "description": { "content": "Update Conversation Attributes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "132165c1-cb2b-45ae-9c3b-8c4318bdbaaa", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 9493.19357918435,\n \"messages\": [\n {\n \"id\": 8804.349991665298,\n \"content\": \"string\",\n \"account_id\": 1962.5700698584303,\n \"inbox_id\": 3072.0965082548655,\n \"conversation_id\": 7125.758480877974,\n \"message_type\": 3,\n \"created_at\": 7497,\n \"updated_at\": 8733,\n \"private\": true,\n \"status\": \"failed\",\n \"source_id\": \"string\",\n \"content_type\": \"input_select\",\n \"content_attributes\": {},\n \"sender_type\": \"Captain::Assistant\",\n \"sender_id\": 3586.297649624822,\n \"external_source_ids\": {},\n \"additional_attributes\": {},\n \"processed_message_content\": \"string\",\n \"sentiment\": {},\n \"conversation\": {},\n \"attachment\": {},\n \"sender\": {}\n },\n {\n \"id\": 2214.556303086669,\n \"content\": \"string\",\n \"account_id\": 1764.854842521756,\n \"inbox_id\": 3875.9648890091157,\n \"conversation_id\": 6953.973475173048,\n \"message_type\": 2,\n \"created_at\": 522,\n \"updated_at\": 2862,\n \"private\": false,\n \"status\": \"failed\",\n \"source_id\": \"string\",\n \"content_type\": \"form\",\n \"content_attributes\": {},\n \"sender_type\": \"Captain::Assistant\",\n \"sender_id\": 8962.827101238694,\n \"external_source_ids\": {},\n \"additional_attributes\": {},\n \"processed_message_content\": \"string\",\n \"sentiment\": {},\n \"conversation\": {},\n \"attachment\": {},\n \"sender\": {}\n }\n ],\n \"account_id\": 5824.673843571723,\n \"uuid\": \"string\",\n \"additional_attributes\": {},\n \"agent_last_seen_at\": 3387.402023391749,\n \"assignee_last_seen_at\": 4907.463918345364,\n \"can_reply\": false,\n \"contact_last_seen_at\": 9464.055157229745,\n \"custom_attributes\": {},\n \"inbox_id\": 5829.723963787426,\n \"labels\": [\n \"string\",\n \"string\"\n ],\n \"muted\": true,\n \"snoozed_until\": 1378.18421774209,\n \"status\": \"open\",\n \"created_at\": 5599.691721180507,\n \"updated_at\": 8846.357861068782,\n \"timestamp\": 4277.2869040037685,\n \"first_reply_created_at\": 9761.74174819712,\n \"unread_count\": 2581.312243329218,\n \"last_non_activity_message\": {\n \"id\": 1968.734421315903,\n \"content\": \"string\",\n \"account_id\": 9484.260358684856,\n \"inbox_id\": 8223.12614194052,\n \"conversation_id\": 1932.7295215859785,\n \"message_type\": 2,\n \"created_at\": 8017,\n \"updated_at\": 3863,\n \"private\": true,\n \"status\": \"null\",\n \"source_id\": \"string\",\n \"content_type\": \"cards\",\n \"content_attributes\": {},\n \"sender_type\": \"AgentBot\",\n \"sender_id\": 3158.763744332249,\n \"external_source_ids\": {},\n \"additional_attributes\": {},\n \"processed_message_content\": \"string\",\n \"sentiment\": {},\n \"conversation\": {},\n \"attachment\": {},\n \"sender\": {}\n },\n \"last_activity_at\": 9476.262673839354,\n \"priority\": \"string\",\n \"waiting_since\": 7979.128951995142,\n \"sla_policy_id\": 8814.693722037315,\n \"applied_sla\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd0a6147-0ad4-423a-b02d-3a12b97ce762", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3067dea-4e58-4fd1-b927-d7876254a523", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e46d6ed-9ea7-4a43-acb3-994b040d1f7e", "name": "Toggle Status", "request": { "name": "Toggle Status", "description": { "content": "Toggle the status of a conversation. Pass `status` to explicitly set the\nconversation state. Use `snoozed` along with `snoozed_until` to snooze a\nconversation until a specific time. If `snoozed_until` is omitted, the\nconversation is snoozed until the next reply from the contact. Regardless\nof the value provided, snoozed conversations always reopen on the next\nreply from the contact.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"open\",\n \"snoozed_until\": 1757506877\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "39eae9be-02f0-443c-b586-934c8aef88c5", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"open\",\n \"snoozed_until\": 1757506877\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {},\n \"payload\": {\n \"success\": false,\n \"current_status\": \"pending\",\n \"conversation_id\": 1915.5000074435768\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b094010b-6c1f-40fc-a516-46e26737b018", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"open\",\n \"snoozed_until\": 1757506877\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c037ce6-dc7e-44d3-b716-16bf11034ebc", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"open\",\n \"snoozed_until\": 1757506877\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f62dc0a7-f932-49b4-8e9a-c443a065737e", "name": "Toggle Priority", "request": { "name": "Toggle Priority", "description": { "content": "Toggles the priority of conversation", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f93e12eb-db8b-40bd-a154-dad981177928", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e42aeadb-8fc0-49d9-9782-9f0e9eea025c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5f78b20-3b78-455d-b804-60a2bdd5d518", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fdc5503-e5fa-4ef7-bd14-e5b7a762b34c", "name": "Toggle Typing Status", "request": { "name": "Toggle Typing Status", "description": { "content": "Toggles the typing status for a conversation.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_typing_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\",\n \"is_private\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b72113a9-2812-4ec7-9aae-e14142fdf72d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_typing_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\",\n \"is_private\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2aa9c5c8-fac5-44ca-bc38-f516e10ad3aa", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_typing_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\",\n \"is_private\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa2366c9-2c87-4916-b036-276bdfd7ecc7", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_typing_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\",\n \"is_private\": false\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e95ea412-2090-47e9-9f6e-df077e33ed88", "name": "Update Custom Attributes", "request": { "name": "Update Custom Attributes", "description": { "content": "Updates the custom attributes of a conversation", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "custom_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {\n \"order_id\": \"12345\",\n \"previous_conversation\": \"67890\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b5d15a50-7883-4e73-a547-129976753170", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "custom_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {\n \"order_id\": \"12345\",\n \"previous_conversation\": \"67890\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"custom_attributes\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d4c8b1f-2a1a-4838-820f-49c6a73a7a08", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "custom_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {\n \"order_id\": \"12345\",\n \"previous_conversation\": \"67890\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faa83f45-b86d-4738-9dd6-6cb80fe67ee9", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "custom_attributes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {\n \"order_id\": \"12345\",\n \"previous_conversation\": \"67890\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a7052bb-f717-4d77-a81b-1f2362c28653", "name": "List Labels", "request": { "name": "List Labels", "description": { "content": "Lists all the labels of a conversation", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "253b58e8-a296-4d7d-8aae-9c19886b5f7f", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9b29d2e-a1fe-41a1-9c02-7f80fdc3b3eb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "261b89f2-2c2f-4a12-8876-f04f1006e039", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3c660fc9-3785-48f4-b285-5032f6e713d5", "name": "Add Labels", "request": { "name": "Add Labels", "description": { "content": "Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7c00a245-bd3e-4b7e-931e-55774e680c89", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f8da1f3-ec34-4b4f-b8fe-90317076aa83", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f5d1764-43d6-49bb-b425-423042dcbff7", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d87879c-0b61-4cfc-8612-cddbdc69014b", "name": "Conversation Reporting Events", "request": { "name": "Conversation Reporting Events", "description": { "content": "Get reporting events for a specific conversation. This endpoint returns events such as first response time, resolution time, and other metrics for the conversation, sorted by creation time in ascending order.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "169f5b3c-8d33-481a-9574-25a1747c3aaf", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 8133.402482682808,\n \"name\": \"string\",\n \"value\": 8021.7260128192065,\n \"value_in_business_hours\": 5684.618893541241,\n \"event_start_time\": \"1949-12-16T16:13:28.935Z\",\n \"event_end_time\": \"1974-09-08T17:52:27.886Z\",\n \"account_id\": 7336.626864579834,\n \"conversation_id\": 1873.0313463105786,\n \"inbox_id\": 994.7610778823979,\n \"user_id\": 3527.232100108444,\n \"created_at\": \"1955-02-16T18:37:37.828Z\",\n \"updated_at\": \"2003-08-20T17:18:19.663Z\"\n },\n {\n \"id\": 6736.941922837069,\n \"name\": \"string\",\n \"value\": 4693.920377716802,\n \"value_in_business_hours\": 1345.5351324439657,\n \"event_start_time\": \"2007-09-10T02:50:57.270Z\",\n \"event_end_time\": \"2021-05-20T08:23:35.608Z\",\n \"account_id\": 2520.3454491485954,\n \"conversation_id\": 6747.137984800217,\n \"inbox_id\": 9169.299170020999,\n \"user_id\": 8186.316647219146,\n \"created_at\": \"2001-08-22T21:27:52.488Z\",\n \"updated_at\": \"1983-12-17T22:25:10.008Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3baf29ce-c864-4836-b395-7c28a07b39b8", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a202e67-d7f2-48e8-bfb0-5e6e7243b1e8", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3a87edc3-112f-4c73-8819-d9678b073c7e", "name": "Atributos Personalizados", "description": { "content": "Custom fields for contacts and conversations", "type": "text/plain" }, "item": [ { "id": "c95243ed-81f3-413a-8af8-6b1b0a114ef4", "name": "List all custom attributes in an account", "request": { "name": "List all custom attributes in an account", "description": { "content": "Get details of custom attributes in an Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "attribute_model", "value": "0", "description": "(Required) conversation_attribute(0)/contact_attribute(1)" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ccd2f93c-af21-48e7-9c9a-284d8cae1c97", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "attribute_model", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 733,\n \"attribute_display_name\": \"string\",\n \"attribute_display_type\": \"string\",\n \"attribute_description\": \"string\",\n \"attribute_key\": \"string\",\n \"regex_pattern\": \"string\",\n \"regex_cue\": \"string\",\n \"attribute_values\": \"string\",\n \"attribute_model\": \"string\",\n \"default_value\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n },\n {\n \"id\": 7175,\n \"attribute_display_name\": \"string\",\n \"attribute_display_type\": \"string\",\n \"attribute_description\": \"string\",\n \"attribute_key\": \"string\",\n \"regex_pattern\": \"string\",\n \"regex_cue\": \"string\",\n \"attribute_values\": \"string\",\n \"attribute_model\": \"string\",\n \"default_value\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d72ee37-1835-4a0e-bb56-6923e60dc281", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "attribute_model", "value": "0" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f79aab10-2582-4302-ad1e-523bd6a97b5c", "name": "Add a new custom attribute", "request": { "name": "Add a new custom attribute", "description": { "content": "Add a new custom attribute to account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c962aa79-1a2c-437a-a72a-a608bf674a07", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 8418,\n \"attribute_display_name\": \"string\",\n \"attribute_display_type\": \"string\",\n \"attribute_description\": \"string\",\n \"attribute_key\": \"string\",\n \"regex_pattern\": \"string\",\n \"regex_cue\": \"string\",\n \"attribute_values\": \"string\",\n \"attribute_model\": \"string\",\n \"default_value\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e9cf716-feae-43b2-b43c-948b13376294", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c6d513ec-8985-4b93-8d43-64f74bd35d46", "name": "Get a custom attribute details", "request": { "name": "Get a custom attribute details", "description": { "content": "Get the details of a custom attribute in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "752e492a-df0a-4899-a421-a042be586212", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 8418,\n \"attribute_display_name\": \"string\",\n \"attribute_display_type\": \"string\",\n \"attribute_description\": \"string\",\n \"attribute_key\": \"string\",\n \"regex_pattern\": \"string\",\n \"regex_cue\": \"string\",\n \"attribute_values\": \"string\",\n \"attribute_model\": \"string\",\n \"default_value\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "032725e4-c5de-45ee-8514-9eb8d09f7b19", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb89396-afd1-4daf-a361-3b3bd6bd511f", "name": "The given attribute ID does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3684759-3796-4a1a-8d68-ac2bc578bdc5", "name": "Update custom attribute in Account", "request": { "name": "Update custom attribute in Account", "description": { "content": "Update a custom attribute in account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2a12c840-bca7-4a37-94aa-5414d190f4ef", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 8418,\n \"attribute_display_name\": \"string\",\n \"attribute_display_type\": \"string\",\n \"attribute_description\": \"string\",\n \"attribute_key\": \"string\",\n \"regex_pattern\": \"string\",\n \"regex_cue\": \"string\",\n \"attribute_values\": \"string\",\n \"attribute_model\": \"string\",\n \"default_value\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88fcfb1a-41e4-44d7-a844-3d35e64872e2", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "029718d0-c710-42aa-9442-ca0e68a8a0b2", "name": "Agent not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"attribute_display_name\": \"Custom Attribute\",\n \"attribute_display_type\": 0,\n \"attribute_description\": \"This is a custom attribute\",\n \"attribute_key\": \"custom_attribute\",\n \"attribute_values\": [\n \"value1\",\n \"value2\"\n ],\n \"attribute_model\": 0,\n \"regex_pattern\": \"^[a-zA-Z0-9]+$\",\n \"regex_cue\": \"Please enter a valid value\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e7a1808-8bc9-482b-bd17-07bae5635bee", "name": "Remove a custom attribute from account", "request": { "name": "Remove a custom attribute from account", "description": { "content": "Remove a custom attribute from account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be deleted" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "93de6381-fa8e-4846-a12d-d58ad53b5fc1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be deleted" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "108b2edc-cf57-4536-9568-0122e2c439d2", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be deleted" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a1a8d23-7ca8-4949-9735-efb25bf518c0", "name": "Custom attribute not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_attribute_definitions", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the custom attribute to be deleted" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "31e3477b-192a-46ba-a115-9a274070a1e5", "name": "Filtros Personalizados", "description": { "content": "Saved filters for conversations", "type": "text/plain" }, "item": [ { "id": "a88f8ad7-48d5-4207-ac40-4cb45d5eea7a", "name": "List all custom filters", "request": { "name": "List all custom filters", "description": { "content": "List all custom filters in a category of a user", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter_type", "value": "contact", "description": "The type of custom filter" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "15338fd3-c248-41bf-b86a-ab07d14fa88c", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter_type", "value": "contact" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 9742.122099961245,\n \"name\": \"string\",\n \"type\": \"report\",\n \"query\": {},\n \"created_at\": \"1994-04-20T02:18:57.980Z\",\n \"updated_at\": \"2007-08-24T08:28:10.501Z\"\n },\n {\n \"id\": 7767.283784312585,\n \"name\": \"string\",\n \"type\": \"contact\",\n \"query\": {},\n \"created_at\": \"1982-11-03T21:26:10.235Z\",\n \"updated_at\": \"1958-07-26T00:31:34.424Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdfe9390-0d5f-464d-8c7f-9b306fd2f098", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter_type", "value": "contact" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04c844a2-9b05-4ae3-9173-3d5b0add1f84", "name": "Create a custom filter", "request": { "name": "Create a custom filter", "description": { "content": "Create a custom filter in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "filter_type", "value": "contact", "description": "The type of custom filter" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c71cdf95-db7f-4579-b1b2-c5c68212f479", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter_type", "value": "contact" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3449.7484278629877,\n \"name\": \"string\",\n \"type\": \"contact\",\n \"query\": {},\n \"created_at\": \"1952-05-13T02:24:28.884Z\",\n \"updated_at\": \"1989-05-30T17:45:17.586Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17abd423-26fd-4dce-9094-1ef0ee1a4661", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "filter_type", "value": "contact" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65792dde-a363-4397-bfcf-8149e3851fed", "name": "Get a custom filter details", "request": { "name": "Get a custom filter details", "description": { "content": "Get the details of a custom filter in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5dd44448-de21-4abc-9bf0-5e307dd9029b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3449.7484278629877,\n \"name\": \"string\",\n \"type\": \"contact\",\n \"query\": {},\n \"created_at\": \"1952-05-13T02:24:28.884Z\",\n \"updated_at\": \"1989-05-30T17:45:17.586Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25bbf7bf-311c-4cc8-b4b3-050ecbece423", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a350bfde-24de-4847-87dd-3dfe00324d6e", "name": "The given team ID does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f43025f3-f609-46af-af41-295b26b8e2d6", "name": "Update a custom filter", "request": { "name": "Update a custom filter", "description": { "content": "Update a custom filter's attributes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b4f2d4b9-bb72-4633-861a-c9ddc4752146", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3449.7484278629877,\n \"name\": \"string\",\n \"type\": \"contact\",\n \"query\": {},\n \"created_at\": \"1952-05-13T02:24:28.884Z\",\n \"updated_at\": \"1989-05-30T17:45:17.586Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90a2e2f8-2a56-4144-8b9f-f1f99f5018d1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"My Custom Filter\",\n \"type\": \"conversation\",\n \"query\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be4679c8-9f3d-49b1-b62b-b9bd27eab67b", "name": "Delete a custom filter", "request": { "name": "Delete a custom filter", "description": { "content": "Delete a custom filter from the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e3c327a5-4313-4c6f-aa51-2c2c917a645e", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a140e9ec-6e94-4d54-836d-83bbcc7b3bfb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db32fd21-3042-4a61-9b51-39cfc3e5ff20", "name": "The custom filter does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "custom_filters", ":custom_filter_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "custom_filter_id", "description": "(Required) The numeric ID of the custom filter" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0ba9e6c2-a316-4754-a35d-5c20bed1c7a8", "name": "Caixas de Entrada", "description": { "content": "Communication channels setup", "type": "text/plain" }, "item": [ { "id": "8946d04c-a9db-49e1-8aa3-22928ecbdbbf", "name": "List all inboxes", "request": { "name": "List all inboxes", "description": { "content": "List all inboxes available in the current account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "54fd2965-b2fb-4dce-b083-32dde4fa2ab3", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 4570.464058023322,\n \"name\": \"string\",\n \"website_url\": \"string\",\n \"channel_type\": \"string\",\n \"avatar_url\": \"string\",\n \"widget_color\": \"string\",\n \"website_token\": \"string\",\n \"enable_auto_assignment\": false,\n \"web_widget_script\": \"string\",\n \"welcome_title\": \"string\",\n \"welcome_tagline\": \"string\",\n \"greeting_enabled\": false,\n \"greeting_message\": \"string\",\n \"channel_id\": 4274.067541581215,\n \"working_hours_enabled\": true,\n \"enable_email_collect\": false,\n \"csat_survey_enabled\": true,\n \"auto_assignment_config\": {},\n \"out_of_office_message\": \"string\",\n \"working_hours\": [\n {\n \"day_of_week\": {\n \"value\": \"\"\n },\n \"closed_all_day\": {\n \"value\": \"\"\n },\n \"open_hour\": {\n \"value\": \"\"\n },\n \"open_minutes\": {\n \"value\": \"\"\n },\n \"close_hour\": {\n \"value\": \"\"\n },\n \"close_minutes\": {\n \"value\": \"\"\n },\n \"open_all_day\": {\n \"value\": \"\"\n }\n },\n {\n \"day_of_week\": {\n \"value\": \"\"\n },\n \"closed_all_day\": {\n \"value\": \"\"\n },\n \"open_hour\": {\n \"value\": \"\"\n },\n \"open_minutes\": {\n \"value\": \"\"\n },\n \"close_hour\": {\n \"value\": \"\"\n },\n \"close_minutes\": {\n \"value\": \"\"\n },\n \"open_all_day\": {\n \"value\": \"\"\n }\n }\n ],\n \"timezone\": \"string\",\n \"callback_webhook_url\": \"string\",\n \"allow_messages_after_resolved\": false,\n \"lock_to_single_conversation\": true,\n \"sender_name_type\": \"string\",\n \"business_name\": \"string\",\n \"hmac_mandatory\": false,\n \"selected_feature_flags\": [\n \"string\",\n \"string\"\n ],\n \"reply_time\": \"string\",\n \"messaging_service_sid\": \"string\",\n \"phone_number\": \"string\",\n \"medium\": \"string\",\n \"provider\": \"string\"\n },\n {\n \"id\": 6287.070283534779,\n \"name\": \"string\",\n \"website_url\": \"string\",\n \"channel_type\": \"string\",\n \"avatar_url\": \"string\",\n \"widget_color\": \"string\",\n \"website_token\": \"string\",\n \"enable_auto_assignment\": false,\n \"web_widget_script\": \"string\",\n \"welcome_title\": \"string\",\n \"welcome_tagline\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"string\",\n \"channel_id\": 7696.177044618768,\n \"working_hours_enabled\": false,\n \"enable_email_collect\": false,\n \"csat_survey_enabled\": false,\n \"auto_assignment_config\": {},\n \"out_of_office_message\": \"string\",\n \"working_hours\": [\n {\n \"day_of_week\": {\n \"value\": \"\"\n },\n \"closed_all_day\": {\n \"value\": \"\"\n },\n \"open_hour\": {\n \"value\": \"\"\n },\n \"open_minutes\": {\n \"value\": \"\"\n },\n \"close_hour\": {\n \"value\": \"\"\n },\n \"close_minutes\": {\n \"value\": \"\"\n },\n \"open_all_day\": {\n \"value\": \"\"\n }\n },\n {\n \"day_of_week\": {\n \"value\": \"\"\n },\n \"closed_all_day\": {\n \"value\": \"\"\n },\n \"open_hour\": {\n \"value\": \"\"\n },\n \"open_minutes\": {\n \"value\": \"\"\n },\n \"close_hour\": {\n \"value\": \"\"\n },\n \"close_minutes\": {\n \"value\": \"\"\n },\n \"open_all_day\": {\n \"value\": \"\"\n }\n }\n ],\n \"timezone\": \"string\",\n \"callback_webhook_url\": \"string\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": false,\n \"sender_name_type\": \"string\",\n \"business_name\": \"string\",\n \"hmac_mandatory\": false,\n \"selected_feature_flags\": [\n \"string\",\n \"string\"\n ],\n \"reply_time\": \"string\",\n \"messaging_service_sid\": \"string\",\n \"phone_number\": \"string\",\n \"medium\": \"string\",\n \"provider\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37628558-7cb5-451b-8203-3d13146ab3b1", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "870c3582-607f-4666-bf3b-f78ed301bd01", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c336650-c9c3-4f85-85ea-15e2c511170d", "name": "Create an inbox", "request": { "name": "Create an inbox", "description": { "content": "You can create more than one website inbox in each account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"type\": \"web_widget\",\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "18e82ca2-82bc-47ff-8bea-aa4802e1f3b9", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"type\": \"web_widget\",\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1804.3402980159995,\n \"name\": \"string\",\n \"website_url\": \"string\",\n \"channel_type\": \"string\",\n \"avatar_url\": \"string\",\n \"widget_color\": \"string\",\n \"website_token\": \"string\",\n \"enable_auto_assignment\": true,\n \"web_widget_script\": \"string\",\n \"welcome_title\": \"string\",\n \"welcome_tagline\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"string\",\n \"channel_id\": 141.16883716023932,\n \"working_hours_enabled\": true,\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"auto_assignment_config\": {},\n \"out_of_office_message\": \"string\",\n \"working_hours\": [\n {\n \"day_of_week\": 1492.5536715302956,\n \"closed_all_day\": true,\n \"open_hour\": 1893.1108618528046,\n \"open_minutes\": 3117.726032357029,\n \"close_hour\": 1191.197513520078,\n \"close_minutes\": 6896.108747087182,\n \"open_all_day\": true\n },\n {\n \"day_of_week\": 3542.835449718238,\n \"closed_all_day\": false,\n \"open_hour\": 1119.992350297916,\n \"open_minutes\": 1595.8908737996446,\n \"close_hour\": 2482.526254302203,\n \"close_minutes\": 4673.202674772573,\n \"open_all_day\": true\n }\n ],\n \"timezone\": \"string\",\n \"callback_webhook_url\": \"string\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"sender_name_type\": \"string\",\n \"business_name\": \"string\",\n \"hmac_mandatory\": true,\n \"selected_feature_flags\": [\n \"string\",\n \"string\"\n ],\n \"reply_time\": \"string\",\n \"messaging_service_sid\": \"string\",\n \"phone_number\": \"string\",\n \"medium\": \"string\",\n \"provider\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "385aa752-2450-4bae-8f8a-ae1245c79531", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"type\": \"web_widget\",\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b413b207-40bd-4372-a6f3-cc7b7e6e9a9c", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"type\": \"web_widget\",\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9dc805a2-7947-45fb-91ca-de68a681a66b", "name": "Get an inbox", "request": { "name": "Get an inbox", "description": { "content": "Get an inbox available in the current account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3727eb9d-c78f-45d4-a967-8a894cf4a1f6", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1804.3402980159995,\n \"name\": \"string\",\n \"website_url\": \"string\",\n \"channel_type\": \"string\",\n \"avatar_url\": \"string\",\n \"widget_color\": \"string\",\n \"website_token\": \"string\",\n \"enable_auto_assignment\": true,\n \"web_widget_script\": \"string\",\n \"welcome_title\": \"string\",\n \"welcome_tagline\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"string\",\n \"channel_id\": 141.16883716023932,\n \"working_hours_enabled\": true,\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"auto_assignment_config\": {},\n \"out_of_office_message\": \"string\",\n \"working_hours\": [\n {\n \"day_of_week\": 1492.5536715302956,\n \"closed_all_day\": true,\n \"open_hour\": 1893.1108618528046,\n \"open_minutes\": 3117.726032357029,\n \"close_hour\": 1191.197513520078,\n \"close_minutes\": 6896.108747087182,\n \"open_all_day\": true\n },\n {\n \"day_of_week\": 3542.835449718238,\n \"closed_all_day\": false,\n \"open_hour\": 1119.992350297916,\n \"open_minutes\": 1595.8908737996446,\n \"close_hour\": 2482.526254302203,\n \"close_minutes\": 4673.202674772573,\n \"open_all_day\": true\n }\n ],\n \"timezone\": \"string\",\n \"callback_webhook_url\": \"string\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"sender_name_type\": \"string\",\n \"business_name\": \"string\",\n \"hmac_mandatory\": true,\n \"selected_feature_flags\": [\n \"string\",\n \"string\"\n ],\n \"reply_time\": \"string\",\n \"messaging_service_sid\": \"string\",\n \"phone_number\": \"string\",\n \"medium\": \"string\",\n \"provider\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b7c888-caca-48c7-a36f-914ffb6fa009", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5332cfcf-7dc3-4b80-8561-fa8deba0c600", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4247962f-2aef-4f54-8ad8-29eb153f7369", "name": "Update Inbox", "request": { "name": "Update Inbox", "description": { "content": "Update an existing inbox", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8dcfadc6-b3ac-4360-b0c0-bcd1c41c790b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1804.3402980159995,\n \"name\": \"string\",\n \"website_url\": \"string\",\n \"channel_type\": \"string\",\n \"avatar_url\": \"string\",\n \"widget_color\": \"string\",\n \"website_token\": \"string\",\n \"enable_auto_assignment\": true,\n \"web_widget_script\": \"string\",\n \"welcome_title\": \"string\",\n \"welcome_tagline\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"string\",\n \"channel_id\": 141.16883716023932,\n \"working_hours_enabled\": true,\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"auto_assignment_config\": {},\n \"out_of_office_message\": \"string\",\n \"working_hours\": [\n {\n \"day_of_week\": 1492.5536715302956,\n \"closed_all_day\": true,\n \"open_hour\": 1893.1108618528046,\n \"open_minutes\": 3117.726032357029,\n \"close_hour\": 1191.197513520078,\n \"close_minutes\": 6896.108747087182,\n \"open_all_day\": true\n },\n {\n \"day_of_week\": 3542.835449718238,\n \"closed_all_day\": false,\n \"open_hour\": 1119.992350297916,\n \"open_minutes\": 1595.8908737996446,\n \"close_hour\": 2482.526254302203,\n \"close_minutes\": 4673.202674772573,\n \"open_all_day\": true\n }\n ],\n \"timezone\": \"string\",\n \"callback_webhook_url\": \"string\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"sender_name_type\": \"string\",\n \"business_name\": \"string\",\n \"hmac_mandatory\": true,\n \"selected_feature_flags\": [\n \"string\",\n \"string\"\n ],\n \"reply_time\": \"string\",\n \"messaging_service_sid\": \"string\",\n \"phone_number\": \"string\",\n \"medium\": \"string\",\n \"provider\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88097597-afd9-44a9-ba78-9327fc902617", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8033069f-3b18-4f7a-a3c4-201a42453c2f", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"string\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hello, how can I help you?\",\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"enable_auto_assignment\": true,\n \"working_hours_enabled\": true,\n \"out_of_office_message\": \"We are currently out of office. Please leave a message and we will get back to you.\",\n \"timezone\": \"America/New_York\",\n \"allow_messages_after_resolved\": true,\n \"lock_to_single_conversation\": true,\n \"portal_id\": 1,\n \"sender_name_type\": \"friendly\",\n \"business_name\": \"My Business\",\n \"channel\": {\n \"website_url\": \"https://example.com\",\n \"welcome_title\": \"Welcome to our support\",\n \"welcome_tagline\": \"We are here to help you\",\n \"widget_color\": \"#FF5733\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b0937bdf-882b-4a33-9f63-2c20c70712ab", "name": "Show Inbox Agent Bot", "request": { "name": "Show Inbox Agent Bot", "description": { "content": "See if an agent bot is associated to the Inbox", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "61cf8b2a-7022-498c-b470-5bc982753f3d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4638.766925447404,\n \"name\": \"string\",\n \"description\": \"string\",\n \"thumbnail\": \"string\",\n \"outgoing_url\": \"string\",\n \"bot_type\": \"string\",\n \"bot_config\": {},\n \"account_id\": 245.04147523004116,\n \"access_token\": \"string\",\n \"system_bot\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c77b70e-df92-4f28-a800-7fc4a9632fd5", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c76b4542-9484-45f8-b20e-6a1f924f4db9", "name": "Inbox not found, Agent bot not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd9baa21-d127-430a-bb0b-f269c1e58a9e", "name": "Add or remove agent bot", "request": { "name": "Add or remove agent bot", "description": { "content": "To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "set_agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"agent_bot\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e28f2f77-ad9e-4c22-b51a-c71d0739bd9d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "set_agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_bot\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fedf8cc0-6bd5-4b55-99b4-3228337ff2ec", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "set_agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_bot\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b777bc-9a73-4394-8329-d7c9b708be59", "name": "Inbox not found, Agent bot not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "set_agent_bot" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the inbox" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_bot\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b3a82d0f-3885-4b76-ba35-792343424b80", "name": "List Agents in Inbox", "request": { "name": "List Agents in Inbox", "description": { "content": "Get Details of Agents in an Inbox", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "inbox_id", "description": "(Required) The ID of the Inbox" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "835cb21b-f918-4781-8363-ed12cc3a0858", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "inbox_id", "description": "(Required) The ID of the Inbox" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 3671,\n \"account_id\": 9884,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": false,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"agent\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 7939\n },\n {\n \"id\": 6131,\n \"account_id\": 2066,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": false,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 5407\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c6672f-c3e9-434d-acd7-a530bc9ad624", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "inbox_id", "description": "(Required) The ID of the Inbox" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c9503f8-ebda-43ce-a3ea-bd8fbdcce025", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "inbox_id", "description": "(Required) The ID of the Inbox" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f672eebf-a2df-434d-b2ea-afdea8afc21c", "name": "Add a New Agent", "request": { "name": "Add a New Agent", "description": { "content": "Add a new Agent to Inbox", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5e20952-38ac-4ab3-9a90-9d9c05f3ae34", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 3671,\n \"account_id\": 9884,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": false,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"agent\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 7939\n },\n {\n \"id\": 6131,\n \"account_id\": 2066,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": false,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 5407\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399fba78-272a-46a0-b50d-972e429a0570", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7afbcbf-7a2c-4b6c-9865-7660b30e200f", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ebb4f7-980e-4e47-bc68-1b9b1aaaf259", "name": "User must exist", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a939495-a970-464c-a77f-706887e7c4f6", "name": "Update Agents in Inbox", "request": { "name": "Update Agents in Inbox", "description": { "content": "All agents except the one passed in params will be removed", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "58866c7a-8716-4301-bad2-244aad4bf448", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 3671,\n \"account_id\": 9884,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": false,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"agent\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 7939\n },\n {\n \"id\": 6131,\n \"account_id\": 2066,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": false,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 5407\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48407473-4711-4d44-b1ad-b33799463f4d", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1b498c3-7bc9-4043-b0ed-72bcd62f8976", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bac039e0-00b0-4fed-b8e2-d810d174d329", "name": "User must exist", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b9e57b8-45e6-490c-85c8-4bcb25eac888", "name": "Remove an Agent from Inbox", "request": { "name": "Remove an Agent from Inbox", "description": { "content": "Remove an Agent from Inbox", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 5546,\n 7075\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c552b242-e1c9-4e4e-b518-b95769284330", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 7179,\n 7908\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aabf30ca-f298-4ead-bf1b-e17389ac4356", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 7179,\n 7908\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ada3c2c2-ea7e-4b11-8ab0-5a6f7d21d1d7", "name": "Inbox not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 7179,\n 7908\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90f4f3b3-96bb-41e5-a7ea-62f50cb3269b", "name": "User must exist", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"string\",\n \"user_ids\": [\n 7179,\n 7908\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "39278f27-4de7-4ca7-a20a-c08e3aa7bcec", "name": "Integrações", "description": { "content": "Third-party integrations", "type": "text/plain" }, "item": [ { "id": "b19b9f39-7c9a-4feb-991f-3cd9c2d92535", "name": "List all the Integrations", "request": { "name": "List all the Integrations", "description": { "content": "Get the details of all Integrations available for the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "771cf1fe-1a30-4465-9c6b-8e1e28be0394", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"hook_type\": \"string\",\n \"enabled\": true,\n \"allow_multiple_hooks\": false\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"hook_type\": \"string\",\n \"enabled\": true,\n \"allow_multiple_hooks\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bbdc45a-d638-4d5e-95ce-b9d90b3ca49d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05795741-b8e6-48d6-b797-b5eb2b1641b8", "name": "Url not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "apps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ab217c2-be91-4513-bcb3-f57ff0430275", "name": "Create an integration hook", "request": { "name": "Create an integration hook", "description": { "content": "Create an integration hook", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"app_id\": 1,\n \"inbox_id\": 1,\n \"status\": 1,\n \"settings\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e6b66ade-868a-4ae8-a309-bc67d6c032fe", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": 1,\n \"inbox_id\": 1,\n \"status\": 1,\n \"settings\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"app_id\": \"string\",\n \"inbox_id\": \"string\",\n \"account_id\": \"string\",\n \"status\": false,\n \"hook_type\": true,\n \"settings\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e722c764-aa61-4619-9f86-820d92c7a396", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"app_id\": 1,\n \"inbox_id\": 1,\n \"status\": 1,\n \"settings\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a77adea2-9969-4807-ab1c-e5b6bebac076", "name": "Update an Integration Hook", "request": { "name": "Update an Integration Hook", "description": { "content": "Update an Integration Hook", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": 1,\n \"settings\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a526d1a5-0525-47e4-af9b-5280e2dd82d1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": 1,\n \"settings\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"string\",\n \"app_id\": \"string\",\n \"inbox_id\": \"string\",\n \"account_id\": \"string\",\n \"status\": false,\n \"hook_type\": true,\n \"settings\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17611bb2-9440-4506-b498-68b3a0397453", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": 1,\n \"settings\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "521ddf5c-c7c5-4c6f-b797-9cac8acf60e5", "name": "Delete an Integration Hook", "request": { "name": "Delete an Integration Hook", "description": { "content": "Delete an Integration Hook", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "fb5f3b51-1e61-45ca-a663-2208c3d39a60", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6fc3ce1-8698-44fa-b390-bcc74a04d6e8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7de3452-39a0-4079-9246-aca141b74243", "name": "The hook does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "integrations", "hooks", ":hook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "hook_id", "description": "(Required) The numeric ID of the integration hook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "243bdc10-1fc2-4124-b14e-3b3d8337535b", "name": "Etiquetas", "description": { "content": "Account label management APIs", "type": "text/plain" }, "item": [ { "id": "cd12c702-d05e-403c-bdf4-3f59c23c4071", "name": "List all labels", "request": { "name": "List all labels", "description": { "content": "List all labels available in the current account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "bb021a42-11be-4ecf-bef0-21ed9680ce22", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 354.5582298197636,\n \"title\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"show_on_sidebar\": true\n },\n {\n \"id\": 2115.684401574831,\n \"title\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"show_on_sidebar\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1740f109-6c88-46fb-855d-bde248f83696", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6c20f81-31f8-4b3b-9157-4a3666610558", "name": "Create a label", "request": { "name": "Create a label", "description": { "content": "Create a label in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"support\",\n \"description\": \"Conversations that need support follow-up\",\n \"color\": \"#1f93ff\",\n \"show_on_sidebar\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "54e4e49b-c0bf-4038-9582-26cac09ce5b1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"support\",\n \"description\": \"Conversations that need support follow-up\",\n \"color\": \"#1f93ff\",\n \"show_on_sidebar\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1111.1860157842846,\n \"title\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"show_on_sidebar\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e74247be-9b39-4b20-a1db-ae68c7dcee2a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"support\",\n \"description\": \"Conversations that need support follow-up\",\n \"color\": \"#1f93ff\",\n \"show_on_sidebar\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e21d6039-e304-4953-8eea-9e437125dd68", "name": "Get a label", "request": { "name": "Get a label", "description": { "content": "Get the details of a label in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0d72a4a6-fcd3-4a62-b3c6-262f9eef64ab", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1111.1860157842846,\n \"title\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"show_on_sidebar\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0ba4c27-575b-4f93-9579-feab20f5a922", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c7c0a49-1f9e-43ea-a3d7-a6615a7cad17", "name": "The given label ID does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d12b019f-caac-41d1-8f34-4f662ee7f22e", "name": "Update a label", "request": { "name": "Update a label", "description": { "content": "Update a label's attributes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"support\",\n \"description\": \"Conversations that need support follow-up\",\n \"color\": \"#1f93ff\",\n \"show_on_sidebar\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b6378f58-2b18-44e4-b2d7-b89b9134142d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"support\",\n \"description\": \"Conversations that need support follow-up\",\n \"color\": \"#1f93ff\",\n \"show_on_sidebar\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1111.1860157842846,\n \"title\": \"string\",\n \"description\": \"string\",\n \"color\": \"string\",\n \"show_on_sidebar\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "798363f1-601f-4892-b4d2-36bf2f5eab64", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"title\": \"support\",\n \"description\": \"Conversations that need support follow-up\",\n \"color\": \"#1f93ff\",\n \"show_on_sidebar\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ea888132-9a3d-4cfc-9f4d-7ca2362aeba2", "name": "Delete a label", "request": { "name": "Delete a label", "description": { "content": "Delete a label from the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8fd8bbd5-a6d2-4c24-b723-176b97951ead", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "32d7940b-9223-4753-a95c-dec7e7ebe92f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b1b1762-9138-4947-978b-143a8e99ca72", "name": "The label does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "id", "description": "(Required) ID of the label" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ed773d29-4833-49d6-9fe5-d6f7fc001ecc", "name": "Mensagens", "description": { "content": "Message management APIs", "type": "text/plain" }, "item": [ { "id": "d7e73954-9352-4133-9464-d2e978c10b07", "name": "Get messages", "request": { "name": "Get messages", "description": { "content": "List all messages of a conversation", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "after", "value": "4630", "description": "Fetch messages after the message with this ID. Returns up to 100 messages in ascending order." }, { "disabled": false, "key": "before", "value": "4630", "description": "Fetch messages before the message with this ID. Returns up to 20 messages in ascending order." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5e3327c0-7300-4594-a0d3-a0d981b8c912", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "4630" }, { "key": "before", "value": "4630" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"labels\": [\n \"string\",\n \"string\"\n ],\n \"additional_attributes\": {},\n \"contact\": {\n \"payload\": [\n {\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"contact_inboxes\": {\n \"value\": \"\"\n }\n },\n {\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"last_activity_at\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"contact_inboxes\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"assignee\": {\n \"id\": 3578,\n \"account_id\": 2322,\n \"availability_status\": \"offline\",\n \"auto_offline\": true,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 3724\n },\n \"agent_last_seen_at\": \"1960-06-09T16:44:30.961Z\",\n \"assignee_last_seen_at\": \"1995-10-09T11:12:28.744Z\"\n },\n \"payload\": [\n {\n \"id\": 373.5547616451207,\n \"content\": \"string\",\n \"account_id\": 9201.614916499631,\n \"inbox_id\": 644.2519726061014,\n \"conversation_id\": 385.9169616271918,\n \"message_type\": 2,\n \"created_at\": 5122,\n \"updated_at\": 6506,\n \"private\": false,\n \"status\": \"delivered\",\n \"source_id\": \"string\",\n \"content_type\": \"input_text\",\n \"content_attributes\": {},\n \"sender_type\": \"Captain::Assistant\",\n \"sender_id\": 5998.546226215291,\n \"external_source_ids\": {},\n \"additional_attributes\": {},\n \"processed_message_content\": \"string\",\n \"sentiment\": {},\n \"conversation\": {},\n \"attachment\": {},\n \"sender\": {}\n },\n {\n \"id\": 5214.114441856134,\n \"content\": \"string\",\n \"account_id\": 3638.2859870624106,\n \"inbox_id\": 2425.287307776822,\n \"conversation_id\": 6382.481344132745,\n \"message_type\": 1,\n \"created_at\": 8203,\n \"updated_at\": 170,\n \"private\": false,\n \"status\": \"null\",\n \"source_id\": \"string\",\n \"content_type\": \"input_textarea\",\n \"content_attributes\": {},\n \"sender_type\": \"Contact\",\n \"sender_id\": 6728.215406361503,\n \"external_source_ids\": {},\n \"additional_attributes\": {},\n \"processed_message_content\": \"string\",\n \"sentiment\": {},\n \"conversation\": {},\n \"attachment\": {},\n \"sender\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39b87c7a-41b9-4fd9-ac76-3a3bda31020d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "4630" }, { "key": "before", "value": "4630" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d9c74ad-3d31-491d-8595-22ac4e703e54", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "4630" }, { "key": "before", "value": "4630" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d6bd6f3-af41-4374-864a-6de71017aaa4", "name": "Create New Message", "request": { "name": "Create New Message", "description": { "content": "Create a new message in the conversation.\n\n## WhatsApp Template Messages\n\nFor WhatsApp channels, you can send structured template messages using the `template_params` field. \nTemplates must be pre-approved in WhatsApp Business Manager.\n\n### Example Templates\n\n**Text with Image Header:**\n```json\n{\n \"content\": \"Hi your order 121212 is confirmed. Please wait for further updates\",\n \"template_params\": {\n \"name\": \"order_confirmation\",\n \"category\": \"MARKETING\",\n \"language\": \"en\",\n \"processed_params\": {\n \"body\": {\n \"1\": \"121212\"\n },\n \"header\": {\n \"media_url\": \"https://picsum.photos/200/300\",\n \"media_type\": \"image\"\n }\n }\n }\n}\n```\n\n**Text with Copy Code Button:**\n```json\n{\n \"content\": \"Special offer! Get 30% off your next purchase. Use the code below\",\n \"template_params\": {\n \"name\": \"discount_coupon\",\n \"category\": \"MARKETING\",\n \"language\": \"en\",\n \"processed_params\": {\n \"body\": {\n \"discount_percentage\": \"30\"\n },\n \"buttons\": [{\n \"type\": \"copy_code\",\n \"parameter\": \"SAVE20\"\n }]\n }\n }\n}\n```\n", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"message_type\": \"outgoing\",\n \"private\": false,\n \"content_type\": \"text\",\n \"content_attributes\": {},\n \"campaign_id\": 1,\n \"template_params\": {\n \"name\": \"purchase_receipt\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"body\": {\n \"1\": \"Visa\",\n \"2\": \"Nike\",\n \"3\": \"Bill\"\n },\n \"header\": {\n \"media_url\": \"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\",\n \"media_type\": \"document\"\n },\n \"buttons\": [\n {\n \"type\": \"url\",\n \"parameter\": \"SSFSDFSD\"\n },\n {\n \"type\": \"copy_code\",\n \"parameter\": \"SSFSDFSD\"\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bea2b571-dd28-40d0-bd24-899b31378b0d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"message_type\": \"outgoing\",\n \"private\": false,\n \"content_type\": \"text\",\n \"content_attributes\": {},\n \"campaign_id\": 1,\n \"template_params\": {\n \"name\": \"purchase_receipt\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"body\": {\n \"1\": \"Visa\",\n \"2\": \"Nike\",\n \"3\": \"Bill\"\n },\n \"header\": {\n \"media_url\": \"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\",\n \"media_type\": \"document\"\n },\n \"buttons\": [\n {\n \"type\": \"copy_code\",\n \"parameter\": \"SSFSDFSD\"\n },\n {\n \"type\": \"url\",\n \"parameter\": \"SSFSDFSD\"\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7528.66595959115,\n \"content\": \"string\",\n \"account_id\": 3041.3310101971947,\n \"inbox_id\": 2414.4824095754802,\n \"conversation_id\": 2003.7999393289142,\n \"message_type\": 2,\n \"created_at\": 5239,\n \"updated_at\": 1079,\n \"private\": false,\n \"status\": \"null\",\n \"source_id\": \"string\",\n \"content_type\": \"cards\",\n \"content_attributes\": {},\n \"sender_type\": \"Captain::Assistant\",\n \"sender_id\": 6684.039376500079,\n \"external_source_ids\": {},\n \"additional_attributes\": {},\n \"processed_message_content\": \"string\",\n \"sentiment\": {},\n \"conversation\": {},\n \"attachment\": {},\n \"sender\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eedba099-3595-4f07-8517-c4e4359e0672", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"message_type\": \"outgoing\",\n \"private\": false,\n \"content_type\": \"text\",\n \"content_attributes\": {},\n \"campaign_id\": 1,\n \"template_params\": {\n \"name\": \"purchase_receipt\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"body\": {\n \"1\": \"Visa\",\n \"2\": \"Nike\",\n \"3\": \"Bill\"\n },\n \"header\": {\n \"media_url\": \"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\",\n \"media_type\": \"document\"\n },\n \"buttons\": [\n {\n \"type\": \"copy_code\",\n \"parameter\": \"SSFSDFSD\"\n },\n {\n \"type\": \"url\",\n \"parameter\": \"SSFSDFSD\"\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04dc3df0-7c88-429d-ad98-f48537c5ff07", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"message_type\": \"outgoing\",\n \"private\": false,\n \"content_type\": \"text\",\n \"content_attributes\": {},\n \"campaign_id\": 1,\n \"template_params\": {\n \"name\": \"purchase_receipt\",\n \"category\": \"UTILITY\",\n \"language\": \"en_US\",\n \"processed_params\": {\n \"body\": {\n \"1\": \"Visa\",\n \"2\": \"Nike\",\n \"3\": \"Bill\"\n },\n \"header\": {\n \"media_url\": \"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf\",\n \"media_type\": \"document\"\n },\n \"buttons\": [\n {\n \"type\": \"copy_code\",\n \"parameter\": \"SSFSDFSD\"\n },\n {\n \"type\": \"url\",\n \"parameter\": \"SSFSDFSD\"\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06ad2b2f-efc9-477a-b880-a0324e780cf3", "name": "Delete a message", "request": { "name": "Delete a message", "description": { "content": "Delete a message and it's attachments from the conversation.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "89464cde-babf-47c1-851e-97cdfa27852f", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e29c88aa-c799-4eec-b391-b21b04f61b2d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2063418-6f46-4f8e-9664-4952817d90e4", "name": "The message or conversation does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "fbac00d3-4e95-450b-9f0d-7d6704b7c816", "name": "Perfil", "description": { "content": "User profile APIs", "type": "text/plain" }, "item": [ { "id": "46cba3a5-c2af-469d-b210-c06cecd0c400", "name": "Fetch user profile", "request": { "name": "Fetch user profile", "description": { "content": "Get the user profile details", "type": "text/plain" }, "url": { "path": [ "api", "v1", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d6b3a9c9-abc6-439b-9226-a628e03f151a", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7237.310213406425,\n \"access_token\": \"string\",\n \"account_id\": 4638.764954287752,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": false,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 3975.124863134112,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"agent\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"id\": 5501.78802371852,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"2017-01-17T05:24:53.763Z\",\n \"role\": \"administrator\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": true,\n \"custom_role_id\": 938.0727679900269,\n \"custom_role\": {}\n },\n {\n \"id\": 1284.0487681288525,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"1986-02-10T13:07:39.685Z\",\n \"role\": \"agent\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": false,\n \"custom_role_id\": 2941.4028021661798,\n \"custom_role\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8ab0357-3ef9-4a60-bbc5-e93ce722fa14", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0680ede-102a-4b41-adfe-3ad8db7a08b2", "name": "Update user profile", "request": { "name": "Update user profile", "description": { "content": "Update the user profile details", "type": "text/plain" }, "url": { "path": [ "api", "v1", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "profile", "value": "{\"name\":\"string\",\"email\":\"string\",\"display_name\":\"string\",\"message_signature\":\"string\",\"phone_number\":\"string\",\"current_password\":\"string\",\"password\":\"string\",\"password_confirmation\":\"string\",\"avatar\":\"string\",\"ui_settings\":{}}", "type": "text", "description": "(Required) " } ] } }, "response": [ { "id": "119db547-3da1-4f20-9a99-857aba6f1b98", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "profile", "value": "{\"name\":\"string\",\"email\":\"string\",\"display_name\":\"string\",\"message_signature\":\"string\",\"phone_number\":\"string\",\"current_password\":\"string\",\"password\":\"string\",\"password_confirmation\":\"string\",\"avatar\":\"string\",\"ui_settings\":{}}", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7237.310213406425,\n \"access_token\": \"string\",\n \"account_id\": 4638.764954287752,\n \"available_name\": \"string\",\n \"avatar_url\": \"string\",\n \"confirmed\": false,\n \"display_name\": \"string\",\n \"message_signature\": \"string\",\n \"email\": \"string\",\n \"hmac_identifier\": \"string\",\n \"inviter_id\": 3975.124863134112,\n \"name\": \"string\",\n \"provider\": \"string\",\n \"pubsub_token\": \"string\",\n \"role\": \"agent\",\n \"ui_settings\": {},\n \"uid\": \"string\",\n \"type\": \"string\",\n \"custom_attributes\": {},\n \"accounts\": [\n {\n \"id\": 5501.78802371852,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"2017-01-17T05:24:53.763Z\",\n \"role\": \"administrator\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": true,\n \"custom_role_id\": 938.0727679900269,\n \"custom_role\": {}\n },\n {\n \"id\": 1284.0487681288525,\n \"name\": \"string\",\n \"status\": \"string\",\n \"active_at\": \"1986-02-10T13:07:39.685Z\",\n \"role\": \"agent\",\n \"permissions\": [\n \"string\",\n \"string\"\n ],\n \"availability\": \"string\",\n \"availability_status\": \"string\",\n \"auto_offline\": false,\n \"custom_role_id\": 2941.4028021661798,\n \"custom_role\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b4c0ceb-9fec-4dae-8f98-92d41dcde2fe", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "profile" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "PUT", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) ", "type": "text/plain" }, "key": "profile", "value": "{\"name\":\"string\",\"email\":\"string\",\"display_name\":\"string\",\"message_signature\":\"string\",\"phone_number\":\"string\",\"current_password\":\"string\",\"password\":\"string\",\"password_confirmation\":\"string\",\"avatar\":\"string\",\"ui_settings\":{}}", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e20a10dd-eab8-46eb-884b-731f75594303", "name": "Relatórios", "description": { "content": "Analytics and reporting APIs", "type": "text/plain" }, "item": [ { "id": "457f6160-0f4c-4b08-883f-754fc30d4f25", "name": "Account Reporting Events", "request": { "name": "Account Reporting Events", "description": { "content": "Get paginated reporting events for the account. This endpoint returns reporting events such as first response time, resolution time, and other metrics. Only administrators can access this endpoint. Results are paginated with 25 items per page.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "The page parameter" }, { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where events should start (Unix timestamp in seconds)" }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where events should stop (Unix timestamp in seconds)" }, { "disabled": false, "key": "inbox_id", "value": "3074.5223851301052", "description": "Filter events by inbox ID" }, { "disabled": false, "key": "user_id", "value": "3074.5223851301052", "description": "Filter events by user/agent ID" }, { "disabled": false, "key": "name", "value": "string", "description": "Filter events by event name (e.g., first_response, resolution, reply_time)" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b04b6e05-9fe1-4b4f-b43a-0fccb9048c76", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "inbox_id", "value": "3074.5223851301052" }, { "key": "user_id", "value": "3074.5223851301052" }, { "key": "name", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"count\": 7013,\n \"current_page\": 2143,\n \"total_pages\": 598\n },\n \"payload\": [\n {\n \"id\": 8632.185813216716,\n \"name\": \"string\",\n \"value\": 748.580572895946,\n \"value_in_business_hours\": 3226.963708167602,\n \"event_start_time\": \"1954-09-20T14:43:00.708Z\",\n \"event_end_time\": \"2010-04-26T14:53:55.000Z\",\n \"account_id\": 2398.1573569420866,\n \"conversation_id\": 8038.792186989097,\n \"inbox_id\": 5835.647321743783,\n \"user_id\": 8972.026843590394,\n \"created_at\": \"2025-10-07T01:04:58.482Z\",\n \"updated_at\": \"2013-03-26T15:56:08.390Z\"\n },\n {\n \"id\": 3524.211175068872,\n \"name\": \"string\",\n \"value\": 9349.479062691164,\n \"value_in_business_hours\": 5160.845245513334,\n \"event_start_time\": \"2018-05-06T09:35:13.798Z\",\n \"event_end_time\": \"1992-10-14T16:23:38.299Z\",\n \"account_id\": 8436.668622243087,\n \"conversation_id\": 6744.756483603191,\n \"inbox_id\": 9399.533296424348,\n \"user_id\": 6326.242634124359,\n \"created_at\": \"2022-07-10T07:54:11.038Z\",\n \"updated_at\": \"2011-03-26T05:00:38.699Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba2dcb58-5523-4076-80ea-7ca83c558739", "name": "Access denied - Only administrators can access this endpoint", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "reporting_events" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "inbox_id", "value": "3074.5223851301052" }, { "key": "user_id", "value": "3074.5223851301052" }, { "key": "name", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c58fa1cb-9990-443a-9c5e-5ba34d4fcd42", "name": "Get Account reports", "request": { "name": "Get Account reports", "description": { "content": "Get Account reports for a specific type, metric and date range", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "metric", "value": "incoming_messages_count", "description": "(Required) The type of metric" }, { "disabled": false, "key": "type", "value": "label", "description": "(Required) Type of report" }, { "disabled": false, "key": "id", "value": "string", "description": "The Id of specific object in case of agent/inbox/label" }, { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7a4556e4-ecbb-49f1-846b-cc71148fdcd2", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "metric", "value": "incoming_messages_count" }, { "key": "type", "value": "label" }, { "key": "id", "value": "string" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"value\": \"string\",\n \"timestamp\": 878.5806684509589\n },\n {\n \"value\": \"string\",\n \"timestamp\": 2912.452699201623\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9691c79-abc0-4894-88c5-d6d3c010fbc9", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "metric", "value": "incoming_messages_count" }, { "key": "type", "value": "label" }, { "key": "id", "value": "string" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "94fa0e6d-c41a-4901-8999-de302545ea6b", "name": "reports not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "metric", "value": "incoming_messages_count" }, { "key": "type", "value": "label" }, { "key": "id", "value": "string" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bc4f137-7826-4e9e-b47e-749b96d045c5", "name": "Get Account reports summary", "request": { "name": "Get Account reports summary", "description": { "content": "Get Account reports summary for a specific type and date range", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "label", "description": "(Required) Type of report" }, { "disabled": false, "key": "id", "value": "string", "description": "The Id of specific object in case of agent/inbox/label" }, { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e0ee98d9-f921-4a6c-b03e-bd49977cbf7e", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "label" }, { "key": "id", "value": "string" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"avg_first_response_time\": \"string\",\n \"avg_resolution_time\": \"string\",\n \"conversations_count\": 3725.8840519145688,\n \"incoming_messages_count\": 8157.27124111815,\n \"outgoing_messages_count\": 1509.5335384279008,\n \"resolutions_count\": 3241.378070013653,\n \"previous\": {\n \"avg_first_response_time\": \"string\",\n \"avg_resolution_time\": \"string\",\n \"conversations_count\": 1447.033217625685,\n \"incoming_messages_count\": 1602.67844474826,\n \"outgoing_messages_count\": 3429.7035845781343,\n \"resolutions_count\": 6949.99444754601\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f03a59e-c953-49d8-ba75-e5577aabcfd8", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "label" }, { "key": "id", "value": "string" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e78c2577-e57c-4194-a688-917127a4f6f7", "name": "reports not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "summary" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "label" }, { "key": "id", "value": "string" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ad36f85d-7551-469f-81cd-2dd0c5d49080", "name": "Account Conversation Metrics", "request": { "name": "Account Conversation Metrics", "description": { "content": "Get conversation metrics for Account", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "account", "description": "(Required) Type of report" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "8a61ff63-0422-4699-b242-ebcedbc3837d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "account" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"open\": 3769.001109935668,\n \"unattended\": 2095.4765833033916,\n \"unassigned\": 4219.446826060348\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36d644ad-a2a5-4cf4-8453-92e8ca48bb52", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "account" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e8774f6-2483-4641-b334-c3940a192b59", "name": "reports not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "account" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9749cce7-5f34-4c25-b155-742030e6dcd5", "name": "Agent Conversation Metrics", "request": { "name": "Agent Conversation Metrics", "description": { "content": "Get conversation metrics for Agent", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "agent", "description": "(Required) Type of report" }, { "disabled": false, "key": "user_id", "value": "string", "description": "The numeric ID of the user" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "3278d33f-db3e-418c-909e-edb121171605", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "agent" }, { "key": "user_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 348.4885331881615,\n \"name\": \"string\",\n \"email\": \"string\",\n \"thumbnail\": \"string\",\n \"availability\": \"string\",\n \"metric\": {\n \"open\": 1882.5461155188416,\n \"unattended\": 3366.9378098374013\n }\n },\n {\n \"id\": 2927.0965016674786,\n \"name\": \"string\",\n \"email\": \"string\",\n \"thumbnail\": \"string\",\n \"availability\": \"string\",\n \"metric\": {\n \"open\": 9794.581960148671,\n \"unattended\": 4732.038558966515\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53875fc5-ea2a-4fc7-94e4-fded23b6ee36", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "agent" }, { "key": "user_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97c56e70-4f9d-4cb4-a744-bee4f250a18d", "name": "reports not found", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "conversations", "" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "type", "value": "agent" }, { "key": "user_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fdb7f7cf-0566-4e53-979d-69c9372b79ce", "name": "Get conversation statistics grouped by channel type", "request": { "name": "Get conversation statistics grouped by channel type", "description": { "content": "Get conversation counts grouped by channel type and status for a given date range.\nReturns statistics for each channel type including open, resolved, pending, snoozed, and total conversation counts.\n\n**Note:** This API endpoint is available only in SiteUp version 4.10.0 and above. The date range is limited to a maximum of 6 months.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "b64b3944-6c39-499a-8e5b-8b952e1ce219", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Channel::WebWidget\": {\n \"open\": 10,\n \"resolved\": 20,\n \"pending\": 5,\n \"snoozed\": 2,\n \"total\": 37\n },\n \"Channel::Api\": {\n \"open\": 5,\n \"resolved\": 15,\n \"pending\": 3,\n \"snoozed\": 1,\n \"total\": 24\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4546338-d84e-438c-a15d-07ddf661f258", "name": "Date range exceeds 6 months limit", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b856b25-a6aa-4fa6-83ac-7b75e8958e85", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "channel" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1b320aa-e393-4ddb-9b7e-9c52411038c0", "name": "Get conversation statistics grouped by inbox", "request": { "name": "Get conversation statistics grouped by inbox", "description": { "content": "Get conversation statistics grouped by inbox for a given date range.\nReturns metrics for each inbox including conversation counts, resolution counts,\naverage first response time, average resolution time, and average reply time.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." }, { "disabled": false, "key": "business_hours", "value": "true", "description": "Whether to calculate metrics using business hours only." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "59fb2aa8-db34-4b32-848e-7838c3ccb6bf", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "business_hours", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"conversations_count\": 150,\n \"resolved_conversations_count\": 120,\n \"avg_resolution_time\": 3600,\n \"avg_first_response_time\": 300,\n \"avg_reply_time\": 600\n },\n {\n \"id\": 2,\n \"conversations_count\": 75,\n \"resolved_conversations_count\": 60,\n \"avg_resolution_time\": 1800,\n \"avg_first_response_time\": 180,\n \"avg_reply_time\": 420\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f1ccea9-4c72-4663-9ee5-486a099a3759", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "inbox" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "business_hours", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77d6ffa9-df6e-4789-956d-985df69d45e6", "name": "Get conversation statistics grouped by agent", "request": { "name": "Get conversation statistics grouped by agent", "description": { "content": "Get conversation statistics grouped by agent for a given date range.\nReturns metrics for each agent including conversation counts, resolution counts,\naverage first response time, average resolution time, and average reply time.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "agent" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." }, { "disabled": false, "key": "business_hours", "value": "true", "description": "Whether to calculate metrics using business hours only." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7281233f-937a-41d6-837a-f39cb0e21f56", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "agent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "business_hours", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"conversations_count\": 150,\n \"resolved_conversations_count\": 120,\n \"avg_resolution_time\": 3600,\n \"avg_first_response_time\": 300,\n \"avg_reply_time\": 600\n },\n {\n \"id\": 2,\n \"conversations_count\": 75,\n \"resolved_conversations_count\": 60,\n \"avg_resolution_time\": 1800,\n \"avg_first_response_time\": 180,\n \"avg_reply_time\": 420\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f038d2b5-4337-493e-8533-da5dd43166bd", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "agent" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "business_hours", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70a1a993-4b30-4a71-bb19-d0a51350d7d6", "name": "Get conversation statistics grouped by team", "request": { "name": "Get conversation statistics grouped by team", "description": { "content": "Get conversation statistics grouped by team for a given date range.\nReturns metrics for each team including conversation counts, resolution counts,\naverage first response time, average resolution time, and average reply time.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "team" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." }, { "disabled": false, "key": "business_hours", "value": "true", "description": "Whether to calculate metrics using business hours only." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d4faee0d-00b4-4e8f-9a33-2034390f0611", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "team" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "business_hours", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"conversations_count\": 250,\n \"resolved_conversations_count\": 200,\n \"avg_resolution_time\": 2800,\n \"avg_first_response_time\": 240,\n \"avg_reply_time\": 500\n },\n {\n \"id\": 2,\n \"conversations_count\": 180,\n \"resolved_conversations_count\": 150,\n \"avg_resolution_time\": 2400,\n \"avg_first_response_time\": 200,\n \"avg_reply_time\": 450\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5117a4cb-356e-4192-a90d-b1e7c79cafa6", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "summary_reports", "team" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "business_hours", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b60136fa-e4fd-434f-a60b-bfeadfc3c779", "name": "Get first response time distribution by channel", "request": { "name": "Get first response time distribution by channel", "description": { "content": "Get the distribution of first response times grouped by channel type.\nReturns conversation counts in different time buckets (0-1h, 1-4h, 4-8h, 8-24h, 24h+) for each channel type.\n\n**Note:** This API endpoint is available only in SiteUp version 4.11.0 and above.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "first_response_time_distribution" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "013c9307-9fd7-434b-98a3-8d7049026868", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "first_response_time_distribution" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"Channel::WebWidget\": {\n \"0-1h\": 150,\n \"1-4h\": 80,\n \"4-8h\": 45,\n \"8-24h\": 30,\n \"24h+\": 15\n },\n \"Channel::Api\": {\n \"0-1h\": 75,\n \"1-4h\": 40,\n \"4-8h\": 20,\n \"8-24h\": 10,\n \"24h+\": 5\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24c7c795-47cb-4630-94e9-06323e98dfea", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "first_response_time_distribution" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b5adcfd8-a01c-4404-9b7c-a6c6104170b6", "name": "Get inbox-label matrix report", "request": { "name": "Get inbox-label matrix report", "description": { "content": "Get a matrix showing the count of conversations for each inbox-label combination.\nReturns a list of inboxes, labels, and a 2D matrix where each cell contains the count of conversations\nin a specific inbox that have a specific label applied.\n\n**Note:** This API endpoint is available only in SiteUp version 4.11.0 and above.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "inbox_label_matrix" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." }, { "disabled": false, "key": "inbox_ids", "value": "7783", "description": "Filter by specific inbox IDs." }, { "disabled": false, "key": "inbox_ids", "value": "57", "description": "Filter by specific inbox IDs." }, { "disabled": false, "key": "label_ids", "value": "7783", "description": "Filter by specific label IDs." }, { "disabled": false, "key": "label_ids", "value": "57", "description": "Filter by specific label IDs." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0341facc-cccb-444e-9edd-c2b4aa8967e5", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "inbox_label_matrix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "inbox_ids", "value": "2287" }, { "key": "inbox_ids", "value": "3072" }, { "key": "label_ids", "value": "2287" }, { "key": "label_ids", "value": "3072" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"inboxes\": [\n {\n \"id\": 5231.392143000775,\n \"name\": \"string\"\n },\n {\n \"id\": 8682.23744227147,\n \"name\": \"string\"\n }\n ],\n \"labels\": [\n {\n \"id\": 8221.328199735426,\n \"title\": \"string\"\n },\n {\n \"id\": 4216.53388509224,\n \"title\": \"string\"\n }\n ],\n \"matrix\": [\n [\n 3747.540965959041,\n 1084.6533104076218\n ],\n [\n 4280.676494965811,\n 1634.398476444906\n ]\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62355ff2-a7a3-4517-8693-c4e6a8533f28", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "inbox_label_matrix" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "since", "value": "string" }, { "key": "until", "value": "string" }, { "key": "inbox_ids", "value": "2287" }, { "key": "inbox_ids", "value": "3072" }, { "key": "label_ids", "value": "2287" }, { "key": "label_ids", "value": "3072" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c02566d-91b3-4aac-8823-deebfce2aa51", "name": "Get outgoing messages count grouped by entity", "request": { "name": "Get outgoing messages count grouped by entity", "description": { "content": "Get the count of outgoing messages grouped by a specified entity (agent, team, inbox, or label).\nWhen grouped by agent, messages sent by bots (AgentBot, Captain::Assistant) are excluded.\n\n**Note:** This API endpoint is available only in SiteUp version 4.11.0 and above.\n", "type": "text/plain" }, "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "outgoing_messages_count" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "group_by", "value": "team", "description": "(Required) The entity to group outgoing message counts by." }, { "disabled": false, "key": "since", "value": "string", "description": "The timestamp from where report should start (Unix timestamp)." }, { "disabled": false, "key": "until", "value": "string", "description": "The timestamp from where report should stop (Unix timestamp)." } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0927c788-723e-4f96-92ea-f0c22de3952b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "outgoing_messages_count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "group_by", "value": "team" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"name\": \"Agent One\",\n \"outgoing_messages_count\": 42\n },\n {\n \"id\": 2,\n \"name\": \"Agent Two\",\n \"outgoing_messages_count\": 18\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0351538e-0f4c-4ee8-8844-ebbd54407123", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v2", "accounts", ":account_id", "reports", "outgoing_messages_count" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "group_by", "value": "team" }, { "key": "since", "value": "string" }, { "key": "until", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "da139f5d-5e70-4c32-bcc1-0da05e161f7f", "name": "Times", "description": { "content": "Team management APIs", "type": "text/plain" }, "item": [ { "id": "f718b1b2-623f-4d91-a123-1b3d5655f609", "name": "List all teams", "request": { "name": "List all teams", "description": { "content": "List all teams available in the current account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6f62a891-d9ee-4321-9fbf-f31db4700fda", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 2836.783060896868,\n \"name\": \"string\",\n \"description\": \"string\",\n \"allow_auto_assign\": false,\n \"account_id\": 2659.4028736602218,\n \"is_member\": false\n },\n {\n \"id\": 8311.045898647906,\n \"name\": \"string\",\n \"description\": \"string\",\n \"allow_auto_assign\": false,\n \"account_id\": 2300.416785141911,\n \"is_member\": true\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f5c36c0-a40f-41c6-a7ee-8c917e199d6e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddc4014d-6776-4219-849a-11634cecbc65", "name": "Create a team", "request": { "name": "Create a team", "description": { "content": "Create a team in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1e90bfbd-274a-42f5-a7f3-981814b9d2f9", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3125.272220373845,\n \"name\": \"string\",\n \"description\": \"string\",\n \"allow_auto_assign\": true,\n \"account_id\": 8890.015665900833,\n \"is_member\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63b6c504-0376-4e6e-8555-0352b2eebe72", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77b83bef-1571-45db-a050-d062c9dc4fda", "name": "Get a team details", "request": { "name": "Get a team details", "description": { "content": "Get the details of a team in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5cf83d7f-8994-4b91-9686-e3ddc39ebb25", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3125.272220373845,\n \"name\": \"string\",\n \"description\": \"string\",\n \"allow_auto_assign\": true,\n \"account_id\": 8890.015665900833,\n \"is_member\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "200dca65-494b-4f67-ac04-50172a93ffbb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0732e5f7-3cf9-4627-a4c9-b66608795b73", "name": "The given team ID does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e39b447-38db-4be8-8097-458aed4e517c", "name": "Update a team", "request": { "name": "Update a team", "description": { "content": "Update a team's attributes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "52a1c39d-c37a-4cc7-9d89-e7b5ea8049a3", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3125.272220373845,\n \"name\": \"string\",\n \"description\": \"string\",\n \"allow_auto_assign\": true,\n \"account_id\": 8890.015665900833,\n \"is_member\": false\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ffb2a7-a919-4eb7-82e3-6ae2a3f189e0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be96f7fe-950f-4421-bc44-1e723497127f", "name": "Delete a team", "request": { "name": "Delete a team", "description": { "content": "Delete a team from the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "e0d11876-5d48-47a5-81ee-ac4085f9fb51", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e76d3048-38d5-4577-819e-5c6820fb2d86", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c974dbfd-f0b5-4641-b046-d658a4610179", "name": "The team does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6a99190f-38ff-48f9-be08-599042e9e370", "name": "List Agents in Team", "request": { "name": "List Agents in Team", "description": { "content": "Get Details of Agents in an Team", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "36e070d2-52af-42e2-bf38-f8428fa84e82", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 9960,\n \"account_id\": 9713,\n \"availability_status\": \"available\",\n \"auto_offline\": true,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 4331\n },\n {\n \"id\": 1637,\n \"account_id\": 5266,\n \"availability_status\": \"busy\",\n \"auto_offline\": false,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 8871\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91655553-b980-444a-8aab-57f179370caa", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdb5cdf9-26a1-40cc-9709-9b9247b713e0", "name": "Team not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65e656b0-2298-4a52-b61d-38077f2b6ea1", "name": "Add a New Agent", "request": { "name": "Add a New Agent", "description": { "content": "Add a new Agent to Team", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "23766961-07c3-4e31-ad5b-087fe517841d", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 7780,\n \"account_id\": 6160,\n \"availability_status\": \"available\",\n \"auto_offline\": true,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 3510\n },\n {\n \"id\": 1734,\n \"account_id\": 9767,\n \"availability_status\": \"available\",\n \"auto_offline\": false,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 4998\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59eca71e-51dd-49ab-acc3-eb0010a7d5c4", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a871274a-c361-4701-b2e4-7ec05d798ace", "name": "Team not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3d6f24f-5e94-4f18-a343-7f372c7cdfa7", "name": "User must exist", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef031eab-0a7f-4517-bc60-b81af5e41960", "name": "Update Agents in Team", "request": { "name": "Update Agents in Team", "description": { "content": "All agents except the one passed in params will be removed", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7d2ac964-cf8b-42a8-b001-8b1484f5e816", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 9960,\n \"account_id\": 9713,\n \"availability_status\": \"available\",\n \"auto_offline\": true,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 4331\n },\n {\n \"id\": 1637,\n \"account_id\": 5266,\n \"availability_status\": \"busy\",\n \"auto_offline\": false,\n \"confirmed\": true,\n \"email\": \"string\",\n \"available_name\": \"string\",\n \"name\": \"string\",\n \"role\": \"administrator\",\n \"thumbnail\": \"string\",\n \"custom_role_id\": 8871\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a1058bf-da73-40ea-9264-216da8e06055", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1002d7e-18d9-4270-b2d6-91905b6555f5", "name": "Team not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dfb440d-f238-48c4-a504-1dd27c2028be", "name": "User must exist", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6725492b-692c-4b31-96bd-dbde7ccb59de", "name": "Remove an Agent from Team", "request": { "name": "Remove an Agent from Team", "description": { "content": "Remove an Agent from Team", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 9579,\n 4641\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f8336a2b-c8a1-464a-8395-9d83bdd34e7b", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 32,\n 6421\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "61fc56ed-95cb-43bc-af63-d560955dc62c", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 32,\n 6421\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6732d11-e2f8-40d8-815f-e7d88d118a74", "name": "Team not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 32,\n 6421\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4b00e4-f315-4332-a70b-f74c2a4c4250", "name": "User must exist", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "team_id", "description": "(Required) The ID of the team to be updated" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 32,\n 6421\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "7b1ccbb7-6096-4dbf-9194-3b070afbd80b", "name": "Webhooks", "description": { "content": "Event notification webhooks", "type": "text/plain" }, "item": [ { "id": "04167005-ba08-4e56-b839-fd1f8daacaaf", "name": "List all webhooks", "request": { "name": "List all webhooks", "description": { "content": "List all webhooks in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "28d9d066-2fd6-491c-bca1-d81c81324344", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 9104.30224280473,\n \"url\": \"string\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"message_created\",\n \"conversation_created\"\n ],\n \"account_id\": 455.14024419440636\n },\n {\n \"id\": 4629.070182259534,\n \"url\": \"string\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"contact_updated\",\n \"contact_created\"\n ],\n \"account_id\": 4827.870580019931\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b5a6c0a-2d2a-467d-b45f-a680d0ac0165", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c5a20d05-c2b3-4baf-89d1-1cbc9f3ed4f9", "name": "Add a webhook", "request": { "name": "Add a webhook", "description": { "content": "Add a webhook subscription to the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dd803c22-37c6-41f8-83c3-af032be8b1c4", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7688.528431665016,\n \"url\": \"string\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"message_updated\",\n \"conversation_updated\"\n ],\n \"account_id\": 7402.3989319459615\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35d52ee0-8655-4ecd-b39d-c6717d214fa4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c41bbf84-98ad-4f9a-a625-cdd702926cbb", "name": "Update a webhook object", "request": { "name": "Update a webhook object", "description": { "content": "Update a webhook object in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a9880cfc-0edf-448d-a161-e859200eb702", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 7688.528431665016,\n \"url\": \"string\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"message_updated\",\n \"conversation_updated\"\n ],\n \"account_id\": 7402.3989319459615\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26df6804-6321-4306-91a7-25a2e818f92e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\",\n \"name\": \"string\",\n \"subscriptions\": [\n \"conversation_created\",\n \"conversation_status_changed\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b9a6917e-210d-4aa0-afb4-3967f34a700f", "name": "Delete a webhook", "request": { "name": "Delete a webhook", "description": { "content": "Delete a webhook from the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "803b4a7c-3976-46ba-9883-e843459426c1", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15c5d4ec-87e7-48d0-b97e-216d318bb5fb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6db0f9fc-2c72-4b5e-b582-a0f1bbd23949", "name": "The webhook does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "webhooks", ":webhook_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "4630", "key": "webhook_id", "description": "(Required) The numeric ID of the webhook" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "56a288b8-2053-4a86-a2b3-b15e6e1f2de0", "name": "Regras de Automação", "description": { "content": "Workflow automation rules", "type": "text/plain" }, "item": [ { "id": "2c2e876f-79aa-4016-b554-8916380e9926", "name": "List all automation rules in an account", "request": { "name": "List all automation rules in an account", "description": { "content": "Get details of automation rules in an Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "The page parameter" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "af91b147-f850-4afe-aa72-516f2f7efe5f", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 6273,\n \"account_id\": 3187,\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"actions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_on\": 8083,\n \"active\": false\n },\n {\n \"id\": 6129,\n \"account_id\": 7390,\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"actions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_on\": 730,\n \"active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b3b4f85-59d7-49a0-9241-d28398e47d81", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7a034ba4-1d4d-4b1e-8e42-3f98290aabaa", "name": "Add a new automation rule", "request": { "name": "Add a new automation rule", "description": { "content": "Add a new automation rule to account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "422bd49e-d315-482d-9e6b-5bde45b8f54a", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 6273,\n \"account_id\": 3187,\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"actions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_on\": 8083,\n \"active\": false\n },\n {\n \"id\": 6129,\n \"account_id\": 7390,\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"actions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_on\": 730,\n \"active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6701fb57-835e-4f49-ab2d-159ca4e4f937", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b079a9a5-a80f-452c-ab87-dc9d8e66531d", "name": "Get a automation rule details", "request": { "name": "Get a automation rule details", "description": { "content": "Get the details of a automation rule in the account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d3f15258-cd39-4678-b1d4-05a267027658", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": {\n \"id\": 90,\n \"account_id\": 1,\n \"name\": \"add-label-bug-if-message-contains-bug\",\n \"description\": \"add-label-bug-if-message-contains-bug\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"values\": [\n \"incoming\"\n ],\n \"attribute_key\": \"message_type\",\n \"query_operator\": \"and\",\n \"filter_operator\": \"equal_to\"\n },\n {\n \"values\": [\n \"bug\"\n ],\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\"\n }\n ],\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"bugs\",\n \"support-query\"\n ]\n }\n ],\n \"created_on\": 1650555440,\n \"active\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc14cb13-94a3-4d1b-9c84-06317f90b465", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bd9ed75-c653-494d-a5f7-dcd330055fad", "name": "The given rule ID does not exist in the account", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65267ebe-b65e-4dfc-a6d9-3c4a4c50ff03", "name": "Update automation rule in Account", "request": { "name": "Update automation rule in Account", "description": { "content": "Update a automation rule in account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9cca3cc7-0481-462c-91fc-dbc0607fdaff", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 6273,\n \"account_id\": 3187,\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"actions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_on\": 8083,\n \"active\": false\n },\n {\n \"id\": 6129,\n \"account_id\": 7390,\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"conditions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"actions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"created_on\": 730,\n \"active\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "092af317-3b7d-4cbd-b046-31b5790f53da", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dddc469-3ebd-47e7-a10c-926780512003", "name": "Rule not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be updated." }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"Add label on message create event\",\n \"description\": \"Add label support and sales on message create event if incoming message content contains text help\",\n \"event_name\": \"message_created\",\n \"active\": false,\n \"actions\": [\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n },\n {\n \"action_name\": \"add_label\",\n \"action_params\": [\n \"support\"\n ]\n }\n ],\n \"conditions\": [\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n },\n {\n \"attribute_key\": \"content\",\n \"filter_operator\": \"contains\",\n \"query_operator\": \"OR\",\n \"values\": [\n \"help\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e5a8514a-cce8-47fc-a3cc-78764df75bc4", "name": "Remove a automation rule from account", "request": { "name": "Remove a automation rule from account", "description": { "content": "Remove a automation rule from account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "7f08feb7-40ca-4e1a-98a6-864479993043", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "537137a4-7699-44b5-baab-941818cf153d", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ca381a0-7d6f-4abe-8470-b66817918668", "name": "automation rule not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "automation_rules", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) The ID of the automation rule to be deleted" }, { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1c28dc2d-6f4c-4e34-809f-32fdeb0cbe92", "name": "Central de Ajuda", "description": { "content": "Knowledge base management", "type": "text/plain" }, "item": [ { "id": "d0f7180d-3ce1-4b2f-8626-4db7eb7d57fc", "name": "Add a new portal", "request": { "name": "Add a new portal", "description": { "content": "Add a new portal to account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f0d8a14e-5298-4497-a809-541865b19e1f", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 3470,\n \"archived\": true,\n \"color\": \"string\",\n \"config\": {\n \"allowed_locales\": {\n \"value\": \"\"\n }\n },\n \"custom_domain\": \"string\",\n \"header_text\": \"string\",\n \"homepage_link\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"page_title\": \"string\",\n \"account_id\": 6288,\n \"inbox\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"website_url\": {\n \"value\": \"\"\n },\n \"channel_type\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"widget_color\": {\n \"value\": \"\"\n },\n \"website_token\": {\n \"value\": \"\"\n },\n \"enable_auto_assignment\": {\n \"value\": \"\"\n },\n \"web_widget_script\": {\n \"value\": \"\"\n },\n \"welcome_title\": {\n \"value\": \"\"\n },\n \"welcome_tagline\": {\n \"value\": \"\"\n },\n \"greeting_enabled\": {\n \"value\": \"\"\n },\n \"greeting_message\": {\n \"value\": \"\"\n },\n \"channel_id\": {\n \"value\": \"\"\n },\n \"working_hours_enabled\": {\n \"value\": \"\"\n },\n \"enable_email_collect\": {\n \"value\": \"\"\n },\n \"csat_survey_enabled\": {\n \"value\": \"\"\n },\n \"auto_assignment_config\": {\n \"value\": \"\"\n },\n \"out_of_office_message\": {\n \"value\": \"\"\n },\n \"working_hours\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"callback_webhook_url\": {\n \"value\": \"\"\n },\n \"allow_messages_after_resolved\": {\n \"value\": \"\"\n },\n \"lock_to_single_conversation\": {\n \"value\": \"\"\n },\n \"sender_name_type\": {\n \"value\": \"\"\n },\n \"business_name\": {\n \"value\": \"\"\n },\n \"hmac_mandatory\": {\n \"value\": \"\"\n },\n \"selected_feature_flags\": {\n \"value\": \"\"\n },\n \"reply_time\": {\n \"value\": \"\"\n },\n \"messaging_service_sid\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"medium\": {\n \"value\": \"\"\n },\n \"provider\": {\n \"value\": \"\"\n }\n },\n \"logo\": {\n \"id\": {\n \"value\": \"\"\n },\n \"portal_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"file_url\": {\n \"value\": \"\"\n },\n \"blob_id\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"all_articles_count\": {\n \"value\": \"\"\n },\n \"archived_articles_count\": {\n \"value\": \"\"\n },\n \"published_count\": {\n \"value\": \"\"\n },\n \"draft_articles_count\": {\n \"value\": \"\"\n },\n \"categories_count\": {\n \"value\": \"\"\n },\n \"default_locale\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"id\": 6226,\n \"archived\": false,\n \"color\": \"string\",\n \"config\": {\n \"allowed_locales\": {\n \"value\": \"\"\n }\n },\n \"custom_domain\": \"string\",\n \"header_text\": \"string\",\n \"homepage_link\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"page_title\": \"string\",\n \"account_id\": 7163,\n \"inbox\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"website_url\": {\n \"value\": \"\"\n },\n \"channel_type\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"widget_color\": {\n \"value\": \"\"\n },\n \"website_token\": {\n \"value\": \"\"\n },\n \"enable_auto_assignment\": {\n \"value\": \"\"\n },\n \"web_widget_script\": {\n \"value\": \"\"\n },\n \"welcome_title\": {\n \"value\": \"\"\n },\n \"welcome_tagline\": {\n \"value\": \"\"\n },\n \"greeting_enabled\": {\n \"value\": \"\"\n },\n \"greeting_message\": {\n \"value\": \"\"\n },\n \"channel_id\": {\n \"value\": \"\"\n },\n \"working_hours_enabled\": {\n \"value\": \"\"\n },\n \"enable_email_collect\": {\n \"value\": \"\"\n },\n \"csat_survey_enabled\": {\n \"value\": \"\"\n },\n \"auto_assignment_config\": {\n \"value\": \"\"\n },\n \"out_of_office_message\": {\n \"value\": \"\"\n },\n \"working_hours\": {\n \"value\": \"\"\n },\n \"timezone\": {\n \"value\": \"\"\n },\n \"callback_webhook_url\": {\n \"value\": \"\"\n },\n \"allow_messages_after_resolved\": {\n \"value\": \"\"\n },\n \"lock_to_single_conversation\": {\n \"value\": \"\"\n },\n \"sender_name_type\": {\n \"value\": \"\"\n },\n \"business_name\": {\n \"value\": \"\"\n },\n \"hmac_mandatory\": {\n \"value\": \"\"\n },\n \"selected_feature_flags\": {\n \"value\": \"\"\n },\n \"reply_time\": {\n \"value\": \"\"\n },\n \"messaging_service_sid\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"medium\": {\n \"value\": \"\"\n },\n \"provider\": {\n \"value\": \"\"\n }\n },\n \"logo\": {\n \"id\": {\n \"value\": \"\"\n },\n \"portal_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"file_url\": {\n \"value\": \"\"\n },\n \"blob_id\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n }\n },\n \"meta\": {\n \"all_articles_count\": {\n \"value\": \"\"\n },\n \"archived_articles_count\": {\n \"value\": \"\"\n },\n \"published_count\": {\n \"value\": \"\"\n },\n \"draft_articles_count\": {\n \"value\": \"\"\n },\n \"categories_count\": {\n \"value\": \"\"\n },\n \"default_locale\": {\n \"value\": \"\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f7e1231-e9e8-4456-8f54-16c3afe98c52", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b773ef49-624d-4ac1-b4ce-0deb3bdd15f9", "name": "List all portals in an account", "request": { "name": "List all portals in an account", "description": { "content": "Get details of portals in an Account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "d403933f-6a79-4e7a-9197-22fb74863533", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 4,\n \"color\": \"#1F93FF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"account_id\": 1,\n \"config\": {\n \"allowed_locales\": [\n {\n \"code\": \"en\",\n \"articles_count\": 32,\n \"categories_count\": 9\n }\n ]\n },\n \"inbox\": {\n \"id\": 37,\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"channel_id\": 1,\n \"name\": \"SiteUp\",\n \"channel_type\": \"Channel::WebWidget\",\n \"greeting_enabled\": true,\n \"widget_color\": \"#1F93FF\",\n \"website_url\": \"SiteUp.com\"\n },\n \"logo\": {\n \"id\": 19399916,\n \"portal_id\": 4,\n \"file_type\": \"image/png\",\n \"account_id\": 1,\n \"file_url\": \"https://example.com/logo.png\",\n \"blob_id\": 21239614,\n \"filename\": \"square.png\"\n },\n \"meta\": {\n \"all_articles_count\": 0,\n \"categories_count\": 9,\n \"default_locale\": \"en\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "992443ac-9323-4df6-8a9e-ee62651cf882", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e48e2a7-8baa-4834-9eaa-4506fc557b45", "name": "Update a portal", "request": { "name": "Update a portal", "description": { "content": "Update a portal to account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c75451fe-c75c-4f1d-b477-7db7906ed957", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": {\n \"id\": 123,\n \"archived\": false,\n \"color\": \"#1F93FF\",\n \"config\": {\n \"allowed_locales\": [\n {\n \"code\": \"en\",\n \"articles_count\": 32,\n \"categories_count\": 9\n }\n ]\n },\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"slug\": \"handbook\",\n \"page_title\": \"Handbook\",\n \"account_id\": 123,\n \"inbox\": {\n \"id\": 123,\n \"name\": \"SiteUp\",\n \"website_url\": \"SiteUp.com\",\n \"channel_type\": \"Channel::WebWidget\",\n \"avatar_url\": \"https://example.com/avatar.png\",\n \"widget_color\": \"#1F93FF\",\n \"website_token\": \"4cWzuf9i9jxN9tbnv8K9STKU\",\n \"enable_auto_assignment\": true,\n \"web_widget_script\": \"\",\n \"welcome_title\": \"Hi there ! 🙌🏼\",\n \"welcome_tagline\": \"We make it simple to connect with us.\",\n \"greeting_enabled\": true,\n \"greeting_message\": \"Hey there 👋, Thank you for reaching out to us.\",\n \"channel_id\": 123,\n \"working_hours_enabled\": true,\n \"enable_email_collect\": true,\n \"csat_survey_enabled\": true,\n \"timezone\": \"America/Los_Angeles\",\n \"business_name\": \"SiteUp\",\n \"hmac_mandatory\": true\n },\n \"logo\": {\n \"id\": 123,\n \"portal_id\": 123,\n \"file_type\": \"image/png\",\n \"account_id\": 123,\n \"file_url\": \"https://example.com/logo.png\",\n \"blob_id\": 123,\n \"filename\": \"square.png\"\n },\n \"meta\": {\n \"all_articles_count\": 32,\n \"categories_count\": 9,\n \"default_locale\": \"en\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c20802d5-4406-4bdb-9792-0d5dc280ea8c", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c42013e-ad51-4ce0-a798-b49a60a1c6cd", "name": "Portal not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"color\": \"#FFFFFF\",\n \"custom_domain\": \"siteup.help\",\n \"header_text\": \"Handbook\",\n \"homepage_link\": \"https://siteup.com.br\",\n \"name\": \"Handbook\",\n \"page_title\": \"Handbook\",\n \"slug\": \"handbook\",\n \"archived\": false,\n \"config\": {\n \"allowed_locales\": [\n \"en\",\n \"es\"\n ],\n \"default_locale\": \"en\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b88f324-032c-4d7e-aa1a-70627efeb4a7", "name": "Add a new category", "request": { "name": "Add a new category", "description": { "content": "Add a new category to portal", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Category Name\",\n \"description\": \"Category description\",\n \"position\": 1,\n \"slug\": \"category-name\",\n \"locale\": \"en\",\n \"icon\": \"📚\",\n \"parent_category_id\": 1,\n \"associated_category_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "11c9d047-1187-414c-9f3a-5b2c8cdce90a", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Category Name\",\n \"description\": \"Category description\",\n \"position\": 1,\n \"slug\": \"category-name\",\n \"locale\": \"en\",\n \"icon\": \"📚\",\n \"parent_category_id\": 1,\n \"associated_category_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 969,\n \"description\": \"string\",\n \"locale\": \"string\",\n \"name\": \"string\",\n \"slug\": \"string\",\n \"position\": 7761,\n \"portal_id\": 5209,\n \"account_id\": 8296,\n \"associated_category_id\": 9081,\n \"parent_category_id\": 2536\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6efa7941-f348-4fda-8fb3-0780e3bd35f2", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id", "categories" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Category Name\",\n \"description\": \"Category description\",\n \"position\": 1,\n \"slug\": \"category-name\",\n \"locale\": \"en\",\n \"icon\": \"📚\",\n \"parent_category_id\": 1,\n \"associated_category_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90248554-ac19-41ca-a727-605393af90f3", "name": "Add a new article", "request": { "name": "Add a new article", "description": { "content": "Add a new article to portal", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Article Title\",\n \"slug\": \"article-title\",\n \"position\": 1,\n \"content\": \"This is the content of the article\",\n \"description\": \"This is the description of the article\",\n \"category_id\": 1,\n \"author_id\": 1,\n \"associated_article_id\": 2,\n \"status\": 1,\n \"locale\": \"en\",\n \"meta\": {\n \"tags\": [\n \"article_name\"\n ],\n \"title\": \"article title\",\n \"description\": \"article description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "88a5b98a-5ea3-4715-8fd2-dcde823f75af", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Article Title\",\n \"slug\": \"article-title\",\n \"position\": 1,\n \"content\": \"This is the content of the article\",\n \"description\": \"This is the description of the article\",\n \"category_id\": 1,\n \"author_id\": 1,\n \"associated_article_id\": 2,\n \"status\": 1,\n \"locale\": \"en\",\n \"meta\": {\n \"tags\": [\n \"article_name\"\n ],\n \"title\": \"article title\",\n \"description\": \"article description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1554,\n \"content\": \"string\",\n \"meta\": {},\n \"position\": 8855,\n \"status\": null,\n \"title\": \"string\",\n \"slug\": \"string\",\n \"views\": 4734,\n \"portal_id\": 9151,\n \"account_id\": 1223,\n \"author_id\": 5242,\n \"category_id\": 697,\n \"folder_id\": 7475,\n \"associated_article_id\": 7121\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24150cf1-cd64-4c65-b253-fa782d12e71d", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "portals", ":id", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "string", "key": "id", "description": "(Required) The slug identifier of the portal" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"Article Title\",\n \"slug\": \"article-title\",\n \"position\": 1,\n \"content\": \"This is the content of the article\",\n \"description\": \"This is the description of the article\",\n \"category_id\": 1,\n \"author_id\": 1,\n \"associated_article_id\": 2,\n \"status\": 1,\n \"locale\": \"en\",\n \"meta\": {\n \"tags\": [\n \"article_name\"\n ],\n \"title\": \"article title\",\n \"description\": \"article description\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f4980c04-f340-4356-97a5-90967444401a", "name": "API Pública - Contatos", "description": { "content": "Public contact APIs", "type": "text/plain" }, "item": [ { "id": "df7f8e11-45c4-45fb-b67d-b125e2e8b7e3", "name": "Create a contact", "request": { "name": "Create a contact", "description": { "content": "Create a contact", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"identifier\": \"1234567890\",\n \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n \"email\": \"alice@acme.inc\",\n \"name\": \"Alice\",\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8f576788-6f47-4a26-a3fe-253b4e4c1d1a", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"1234567890\",\n \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n \"email\": \"alice@acme.inc\",\n \"name\": \"Alice\",\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 5737,\n \"source_id\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"pubsub_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "529b047f-522b-4049-bd75-c4fbafbae594", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"1234567890\",\n \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n \"email\": \"alice@acme.inc\",\n \"name\": \"Alice\",\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be4b2ab1-18aa-4ad6-9b3a-f6be7f34d482", "name": "Get a contact", "request": { "name": "Get a contact", "description": { "content": "Get the details of a contact", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "714f7842-4707-4287-8259-9316c9d77d1c", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 5737,\n \"source_id\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"pubsub_token\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84b62cef-9201-4d63-9088-eb8211990a8f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9088517-cac1-4cc5-a38f-5f4dc0d9d006", "name": "The given contact does not exist", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8b95b70d-269c-498f-835d-540e15919537", "name": "Update a contact", "request": { "name": "Update a contact", "description": { "content": "Update a contact's attributes", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"identifier\": \"1234567890\",\n \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n \"email\": \"alice@acme.inc\",\n \"name\": \"Alice\",\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c00289d7-353c-4ecd-b455-ad2ced89e483", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"1234567890\",\n \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n \"email\": \"alice@acme.inc\",\n \"name\": \"Alice\",\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4084,\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": true,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"contact_type\": \"string\",\n \"country_code\": \"string\",\n \"last_activity_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"last_name\": \"string\",\n \"middle_name\": \"string\",\n \"location\": \"string\",\n \"account_id\": 2149,\n \"company_id\": 7550,\n \"label_list\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6933cd9f-f484-4d46-944f-4d25d8902be5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"1234567890\",\n \"identifier_hash\": \"e93275d4eba0e5679ad55f5360af00444e2a888df9b0afa3e8b691c3173725f9\",\n \"email\": \"alice@acme.inc\",\n \"name\": \"Alice\",\n \"phone_number\": \"+123456789\",\n \"avatar\": \"string\",\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b75282c2-8c47-4407-9e62-9e5ddcbf9fd7", "name": "API Pública - Conversas", "description": { "content": "Public conversation APIs", "type": "text/plain" }, "item": [ { "id": "d763f714-4a90-4a7d-a953-0adcb1647675", "name": "Create a conversation", "request": { "name": "Create a conversation", "description": { "content": "Create a conversation", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "34340d29-6afd-4785-a290-40ccc24d46b1", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2578,\n \"uuid\": \"string\",\n \"inbox_id\": 7670,\n \"contact_last_seen_at\": 5484,\n \"status\": \"pending\",\n \"agent_last_seen_at\": 6083,\n \"messages\": [\n {\n \"id\": 5836,\n \"content\": \"string\",\n \"message_type\": 7767,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 5022,\n \"conversation_id\": 9955,\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"key_0\": false,\n \"key_1\": false\n }\n },\n {\n \"id\": 8613,\n \"content\": \"string\",\n \"message_type\": 6686,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 9287,\n \"conversation_id\": 2673,\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"contact\": {\n \"id\": 5529,\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"contact_type\": \"string\",\n \"country_code\": \"string\",\n \"last_activity_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"last_name\": \"string\",\n \"middle_name\": \"string\",\n \"location\": \"string\",\n \"account_id\": 3840,\n \"company_id\": 1905,\n \"label_list\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 4312.16170395233,\n \"key_1\": 2775,\n \"key_2\": 1696\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a38de6e4-e6cb-4e83-a776-273731961832", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be531b9c-4749-401f-a7fe-ec808b781997", "name": "List all conversations", "request": { "name": "List all conversations", "description": { "content": "List all conversations for the contact", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "7c3aae50-f28e-4523-96de-213a26ae1606", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 7877,\n \"uuid\": \"string\",\n \"inbox_id\": 5969,\n \"contact_last_seen_at\": 7922,\n \"status\": \"open\",\n \"agent_last_seen_at\": 4479,\n \"messages\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"attachments\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"attachments\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n }\n ],\n \"contact\": {\n \"id\": 7168,\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": true,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"contact_type\": \"string\",\n \"country_code\": \"string\",\n \"last_activity_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"last_name\": \"string\",\n \"middle_name\": \"string\",\n \"location\": \"string\",\n \"account_id\": 1993,\n \"company_id\": 6746,\n \"label_list\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"key_0\": \"string\"\n }\n },\n {\n \"id\": 4285,\n \"uuid\": \"string\",\n \"inbox_id\": 618,\n \"contact_last_seen_at\": 6079,\n \"status\": \"snoozed\",\n \"agent_last_seen_at\": 6886,\n \"messages\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"attachments\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"content\": {\n \"value\": \"\"\n },\n \"message_type\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"content_attributes\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"conversation_id\": {\n \"value\": \"\"\n },\n \"attachments\": {\n \"value\": \"\"\n },\n \"sender\": {\n \"value\": \"\"\n }\n }\n ],\n \"contact\": {\n \"id\": 2190,\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"contact_type\": \"string\",\n \"country_code\": \"string\",\n \"last_activity_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"last_name\": \"string\",\n \"middle_name\": \"string\",\n \"location\": \"string\",\n \"account_id\": 657,\n \"company_id\": 9156,\n \"label_list\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dce5a862-af04-460a-bfc9-f17a4c3d2a55", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e746d57-ce5e-480f-8ca6-84e25d01e523", "name": "Get a single conversation", "request": { "name": "Get a single conversation", "description": { "content": "Retrieves the details of a specific conversation", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b82ea152-1ed5-4c5e-b85b-ac3f1d0080e2", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2578,\n \"uuid\": \"string\",\n \"inbox_id\": 7670,\n \"contact_last_seen_at\": 5484,\n \"status\": \"pending\",\n \"agent_last_seen_at\": 6083,\n \"messages\": [\n {\n \"id\": 5836,\n \"content\": \"string\",\n \"message_type\": 7767,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 5022,\n \"conversation_id\": 9955,\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"key_0\": false,\n \"key_1\": false\n }\n },\n {\n \"id\": 8613,\n \"content\": \"string\",\n \"message_type\": 6686,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 9287,\n \"conversation_id\": 2673,\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"contact\": {\n \"id\": 5529,\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"contact_type\": \"string\",\n \"country_code\": \"string\",\n \"last_activity_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"last_name\": \"string\",\n \"middle_name\": \"string\",\n \"location\": \"string\",\n \"account_id\": 3840,\n \"company_id\": 1905,\n \"label_list\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 4312.16170395233,\n \"key_1\": 2775,\n \"key_2\": 1696\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84037ee9-2790-4974-9b28-59c29c5281fb", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "870b3d22-122c-4a6a-9e51-d6c2ff552563", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "376210fe-44e5-49c4-872b-6774bac7ac43", "name": "Resolve a conversation", "request": { "name": "Resolve a conversation", "description": { "content": "Marks a conversation as resolved", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "dd1a5457-0dba-411f-b19f-f6d7f0db89cc", "name": "Conversation resolved successfully", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 2578,\n \"uuid\": \"string\",\n \"inbox_id\": 7670,\n \"contact_last_seen_at\": 5484,\n \"status\": \"pending\",\n \"agent_last_seen_at\": 6083,\n \"messages\": [\n {\n \"id\": 5836,\n \"content\": \"string\",\n \"message_type\": 7767,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 5022,\n \"conversation_id\": 9955,\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"key_0\": false,\n \"key_1\": false\n }\n },\n {\n \"id\": 8613,\n \"content\": \"string\",\n \"message_type\": 6686,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 9287,\n \"conversation_id\": 2673,\n \"attachments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"sender\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"contact\": {\n \"id\": 5529,\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"contact_type\": \"string\",\n \"country_code\": \"string\",\n \"last_activity_at\": \"string\",\n \"created_at\": \"string\",\n \"updated_at\": \"string\",\n \"last_name\": \"string\",\n \"middle_name\": \"string\",\n \"location\": \"string\",\n \"account_id\": 3840,\n \"company_id\": 1905,\n \"label_list\": [\n \"string\",\n \"string\"\n ],\n \"key_0\": 4312.16170395233,\n \"key_1\": 2775,\n \"key_2\": 1696\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60e9f3d3-9251-4a91-805c-c83858acf357", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac331ce4-3e4f-4f19-8b40-e7e43a112d8e", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0eea1a3f-8edd-49f0-90f1-db1979fdb2cf", "name": "Toggle typing status", "request": { "name": "Toggle typing status", "description": { "content": "Toggles the typing status in a conversation", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_typing" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "typing_status", "value": "string", "description": "(Required) Typing status, either 'on' or 'off'" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "375b5f6a-7843-4e1d-a7e2-5119e7a44772", "name": "Typing status toggled successfully", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_typing" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "typing_status", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cba216d0-d5e5-4db9-aef0-794d193bd97f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_typing" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "typing_status", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b4e11ef-4ca2-4cf8-b0bf-d725641c6fbe", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "toggle_typing" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "typing_status", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ebb129c2-58ad-447b-ad62-3ad1a298c1ad", "name": "Update last seen", "request": { "name": "Update last seen", "description": { "content": "Updates the last seen time of the contact in a conversation", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "update_last_seen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "04931d1d-260b-4a73-8e8e-b63c626ee550", "name": "Last seen updated successfully", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "update_last_seen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a9100e6e-b076-44a7-9d8e-f549fe48a34e", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "update_last_seen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "739496e3-29ac-40be-8ced-e3cb62ea558c", "name": "Conversation not found", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "update_last_seen" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "4ea32ff6-c0e1-45e1-b57d-61dffe258241", "name": "API Pública - Mensagens", "description": { "content": "Public message APIs", "type": "text/plain" }, "item": [ { "id": "05524ffd-82e5-47e8-b169-d6894b4501f3", "name": "Create a message", "request": { "name": "Create a message", "description": { "content": "Create a message", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"echo_id\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "73f218ff-c03c-489c-8584-cc641a6779a6", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"echo_id\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4295,\n \"content\": \"string\",\n \"message_type\": 2464,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 1946,\n \"conversation_id\": 929,\n \"attachments\": [\n {\n \"id\": 7181,\n \"message_id\": 6288,\n \"file_type\": \"contact\",\n \"account_id\": 6074,\n \"extension\": \"string\",\n \"data_url\": \"string\",\n \"thumb_url\": \"string\",\n \"file_size\": 3603,\n \"width\": 1820,\n \"height\": 4595,\n \"coordinates_lat\": 3907.387854663428,\n \"coordinates_long\": 2819.546848489063,\n \"fallback_title\": \"string\",\n \"meta\": {},\n \"transcribed_text\": \"string\"\n },\n {\n \"id\": 713,\n \"message_id\": 9686,\n \"file_type\": \"ig_story\",\n \"account_id\": 5169,\n \"extension\": \"string\",\n \"data_url\": \"string\",\n \"thumb_url\": \"string\",\n \"file_size\": 4379,\n \"width\": 42,\n \"height\": 9220,\n \"coordinates_lat\": 97.90395971472799,\n \"coordinates_long\": 1384.0277700897873,\n \"fallback_title\": \"string\",\n \"meta\": {},\n \"transcribed_text\": \"string\"\n }\n ],\n \"sender\": {\n \"id\": 9158,\n \"name\": \"string\",\n \"avatar_url\": \"string\",\n \"thumbnail\": \"string\",\n \"type\": \"user\",\n \"available_name\": \"string\",\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"description\": \"string\",\n \"created_at\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f669cfac-a1cc-40b2-b86c-d2ab229c6456", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello, how can I help you?\",\n \"echo_id\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6d81f37e-31ef-46cf-841e-ccbcab2be703", "name": "List all messages", "request": { "name": "List all messages", "description": { "content": "List all messages in the conversation", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "18b0a20a-c23f-4a4f-8945-e25d148214f3", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 2019,\n \"content\": \"string\",\n \"message_type\": 6446,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 7353,\n \"conversation_id\": 1461,\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"extension\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n },\n \"coordinates_lat\": {\n \"value\": \"\"\n },\n \"coordinates_long\": {\n \"value\": \"\"\n },\n \"fallback_title\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n },\n \"transcribed_text\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"extension\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n },\n \"coordinates_lat\": {\n \"value\": \"\"\n },\n \"coordinates_long\": {\n \"value\": \"\"\n },\n \"fallback_title\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n },\n \"transcribed_text\": {\n \"value\": \"\"\n },\n \"key_0\": 2660,\n \"key_1\": 46.071627045978225,\n \"key_2\": 1703\n }\n ],\n \"sender\": {\n \"id\": 7316,\n \"name\": \"string\",\n \"avatar_url\": \"string\",\n \"thumbnail\": \"string\",\n \"type\": \"agent_bot\",\n \"available_name\": \"string\",\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"description\": \"string\",\n \"created_at\": \"string\"\n }\n },\n {\n \"id\": 3254,\n \"content\": \"string\",\n \"message_type\": 3772,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 6396,\n \"conversation_id\": 8398,\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"extension\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n },\n \"coordinates_lat\": {\n \"value\": \"\"\n },\n \"coordinates_long\": {\n \"value\": \"\"\n },\n \"fallback_title\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n },\n \"transcribed_text\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"extension\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n },\n \"width\": {\n \"value\": \"\"\n },\n \"height\": {\n \"value\": \"\"\n },\n \"coordinates_lat\": {\n \"value\": \"\"\n },\n \"coordinates_long\": {\n \"value\": \"\"\n },\n \"fallback_title\": {\n \"value\": \"\"\n },\n \"meta\": {\n \"value\": \"\"\n },\n \"transcribed_text\": {\n \"value\": \"\"\n }\n }\n ],\n \"sender\": {\n \"id\": 7636,\n \"name\": \"string\",\n \"avatar_url\": \"string\",\n \"thumbnail\": \"string\",\n \"type\": \"captain_assistant\",\n \"available_name\": \"string\",\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": true,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"description\": \"string\",\n \"created_at\": \"string\"\n }\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a484fe3-a1d1-4587-985a-42db68437104", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94833fb3-edb5-4fd0-b263-5afeb4ac23e6", "name": "Update a message", "request": { "name": "Update a message", "description": { "content": "Update a message", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"submitted_values\": {\n \"name\": \"My Name\",\n \"title\": \"My Title\",\n \"value\": \"value\",\n \"csat_survey_response\": {\n \"feedback_message\": \"Great service!\",\n \"rating\": 5\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b005707f-a208-4355-8e99-b539794e0b23", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"submitted_values\": {\n \"name\": \"My Name\",\n \"title\": \"My Title\",\n \"value\": \"value\",\n \"csat_survey_response\": {\n \"feedback_message\": \"Great service!\",\n \"rating\": 5\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 4295,\n \"content\": \"string\",\n \"message_type\": 2464,\n \"content_type\": \"string\",\n \"content_attributes\": {},\n \"created_at\": 1946,\n \"conversation_id\": 929,\n \"attachments\": [\n {\n \"id\": 7181,\n \"message_id\": 6288,\n \"file_type\": \"contact\",\n \"account_id\": 6074,\n \"extension\": \"string\",\n \"data_url\": \"string\",\n \"thumb_url\": \"string\",\n \"file_size\": 3603,\n \"width\": 1820,\n \"height\": 4595,\n \"coordinates_lat\": 3907.387854663428,\n \"coordinates_long\": 2819.546848489063,\n \"fallback_title\": \"string\",\n \"meta\": {},\n \"transcribed_text\": \"string\"\n },\n {\n \"id\": 713,\n \"message_id\": 9686,\n \"file_type\": \"ig_story\",\n \"account_id\": 5169,\n \"extension\": \"string\",\n \"data_url\": \"string\",\n \"thumb_url\": \"string\",\n \"file_size\": 4379,\n \"width\": 42,\n \"height\": 9220,\n \"coordinates_lat\": 97.90395971472799,\n \"coordinates_long\": 1384.0277700897873,\n \"fallback_title\": \"string\",\n \"meta\": {},\n \"transcribed_text\": \"string\"\n }\n ],\n \"sender\": {\n \"id\": 9158,\n \"name\": \"string\",\n \"avatar_url\": \"string\",\n \"thumbnail\": \"string\",\n \"type\": \"user\",\n \"available_name\": \"string\",\n \"availability_status\": \"string\",\n \"email\": \"string\",\n \"phone_number\": \"string\",\n \"identifier\": \"string\",\n \"blocked\": false,\n \"additional_attributes\": {},\n \"custom_attributes\": {},\n \"description\": \"string\",\n \"created_at\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00925033-6609-4174-bd54-91aa4f361242", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier", "contacts", ":contact_identifier", "conversations", ":conversation_id", "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" }, { "disabled": false, "type": "any", "value": "string", "key": "contact_identifier", "description": "(Required) The source id of contact obtained on contact create" }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) The numeric ID of the conversation" }, { "disabled": false, "type": "any", "value": "4630", "key": "message_id", "description": "(Required) The numeric ID of the message" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"submitted_values\": {\n \"name\": \"My Name\",\n \"title\": \"My Title\",\n \"value\": \"value\",\n \"csat_survey_response\": {\n \"feedback_message\": \"Great service!\",\n \"rating\": 5\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "9f880f94-2a63-475a-a7c4-1254e9a9851b", "name": "Pesquisa CSAT", "description": { "content": "Customer satisfaction survey", "type": "text/plain" }, "item": [ { "id": "34d1dc67-c3db-4b6d-84e0-f55fea032b27", "name": "Get CSAT survey page", "request": { "name": "Get CSAT survey page", "description": { "content": "You can redirect the client to this URL, instead of implementing the CSAT survey component yourself.", "type": "text/plain" }, "url": { "path": [ "survey", "responses", ":conversation_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "conversation_uuid", "description": "(Required) The uuid of the conversation" } ] }, "method": "GET", "auth": null }, "response": [ { "id": "7fd11472-c5be-422a-8d0b-6d6a19a8f529", "name": "Success", "originalRequest": { "url": { "path": [ "survey", "responses", ":conversation_uuid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "conversation_uuid", "description": "(Required) The uuid of the conversation" } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "386d2f51-c522-4563-9952-dbb20053117b", "name": "Funis", "description": { "content": "Operações relacionadas aos funis de vendas", "type": "text/plain" }, "item": [ { "id": "be89b021-0003-4de5-938e-aa11f8915502", "name": "Listar funnels", "request": { "name": "Listar funnels", "description": { "content": "Retorna todos os funis de vendas da conta ordenados por nome", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "31648836-4374-4f3d-9b93-7e5be4b5e49f", "name": "Lista de funnels retornada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 1,\n \"name\": \"Funnel de Vendas\",\n \"description\": \"Funnel principal de vendas\",\n \"active\": true,\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "808427f2-c47c-468b-8cc0-83fca59ac734", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06419971-fd63-45bc-8974-ed8dda0de73b", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a7d0bb5-0053-4ef3-82dc-d4ebe322e437", "name": "Criar funnel", "request": { "name": "Criar funnel", "description": { "content": "Cria um novo funil de vendas com validação de IDs únicos de etapas", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Novo Funnel\",\n \"description\": \"Descrição do funil\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\",\n \"id\": \"lead_1\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\",\n \"id\": \"prospect_1\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\",\n \"id\": \"customer_1\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e01261ae-20a1-442e-a41e-ef9d44532dcc", "name": "Funnel criado com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Novo Funnel\",\n \"description\": \"Descrição do funil\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\",\n \"id\": \"lead_1\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\",\n \"id\": \"prospect_1\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\",\n \"id\": \"customer_1\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"name\": \"Funnel de Vendas\",\n \"account_id\": 1,\n \"description\": \"Funnel principal de vendas\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\"\n }\n },\n \"settings\": {\n \"key_0\": false,\n \"key_1\": 7356,\n \"key_2\": \"string\"\n },\n \"global_custom_attributes\": [\n {\n \"name\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7109adcd-04ae-4e21-a839-f38a7f584b0b", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Novo Funnel\",\n \"description\": \"Descrição do funil\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\",\n \"id\": \"lead_1\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\",\n \"id\": \"prospect_1\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\",\n \"id\": \"customer_1\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bd4877f-b9b2-472b-bc45-433d230d16b1", "name": "Limite de funnels atingido", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Novo Funnel\",\n \"description\": \"Descrição do funil\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\",\n \"id\": \"lead_1\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\",\n \"id\": \"prospect_1\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\",\n \"id\": \"customer_1\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Limite de funnels atingido. Atualize para a versão PRO para criar mais funnels.\",\n \"code\": \"FUNNEL_LIMIT_REACHED\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "873b07b0-8417-4c1c-9d1c-519101eeb9d6", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Novo Funnel\",\n \"description\": \"Descrição do funil\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\",\n \"id\": \"lead_1\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\",\n \"id\": \"prospect_1\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\",\n \"id\": \"customer_1\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0e248365-223c-4925-958c-c1268cbdf2a0", "name": "Obter funnel", "request": { "name": "Obter funnel", "description": { "content": "Retorna detalhes de um funil específico", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c9867216-c0bc-40c2-8608-039b3816fd57", "name": "Funnel encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"name\": \"Funnel de Vendas\",\n \"account_id\": 1,\n \"description\": \"Funnel principal de vendas\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\"\n }\n },\n \"settings\": {\n \"key_0\": false,\n \"key_1\": 7356,\n \"key_2\": \"string\"\n },\n \"global_custom_attributes\": [\n {\n \"name\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c1c34e2-ec03-44f6-80b2-bc596a032712", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f646d1b0-52a6-4455-a8bf-515cf511d6b9", "name": "Atualizar funnel", "request": { "name": "Atualizar funnel", "description": { "content": "Atualiza um funil de vendas existente", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Funnel Atualizado\",\n \"description\": \"Nova descrição\",\n \"active\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f958fd05-ae79-4d7f-b3e3-9c245641e8be", "name": "Funnel atualizado com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Funnel Atualizado\",\n \"description\": \"Nova descrição\",\n \"active\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"name\": \"Funnel de Vendas\",\n \"account_id\": 1,\n \"description\": \"Funnel principal de vendas\",\n \"active\": true,\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\"\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\"\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\"\n }\n },\n \"settings\": {\n \"key_0\": false,\n \"key_1\": 7356,\n \"key_2\": \"string\"\n },\n \"global_custom_attributes\": [\n {\n \"name\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b4f157b-ca63-4785-85db-66ed01bfc919", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Funnel Atualizado\",\n \"description\": \"Nova descrição\",\n \"active\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9f9d75c-4e52-4ca2-b290-6850d3768ccd", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Funnel Atualizado\",\n \"description\": \"Nova descrição\",\n \"active\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c2e3635-678d-4f71-9e53-108b541f0282", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Funnel Atualizado\",\n \"description\": \"Nova descrição\",\n \"active\": true\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b8121ac-4365-42c1-8f76-8115558f2bdc", "name": "Excluir funnel", "request": { "name": "Excluir funnel", "description": { "content": "Exclui um funil de vendas", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "400fcce6-d6ad-43af-94f9-7e62095d0dc0", "name": "Funnel excluído com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "520a899a-6956-4d7f-98e3-eb8d74fe3423", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a1506596-c66a-4f54-a79f-9aee826e27d1", "name": "Estatísticas por etapa", "request": { "name": "Estatísticas por etapa", "description": { "content": "Retorna estatísticas dos itens por etapa do funil (name, color, description, count, total_value).\nAceita filtros opcionais: prioridades, agente, valor, datas e exibição de won/lost.\n", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "funnels", ":id", "stage_stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "priorities", "value": "high", "description": "Filtrar por prioridades (array)" }, { "disabled": false, "key": "priorities", "value": "medium", "description": "Filtrar por prioridades (array)" }, { "disabled": false, "key": "agent_id", "value": "1", "description": "ID do agente; use -1 para itens não atribuídos" }, { "disabled": false, "key": "value_min", "value": "3074.5223851301052", "description": "Valor mínimo do item" }, { "disabled": false, "key": "value_max", "value": "3074.5223851301052", "description": "Valor máximo do item" }, { "disabled": false, "key": "date_start", "value": "1986-04-11T17:19:45.950Z", "description": "Filtrar itens criados a partir desta data" }, { "disabled": false, "key": "date_end", "value": "1986-04-11T17:19:45.950Z", "description": "Filtrar itens criados até esta data" }, { "disabled": false, "key": "show_won", "value": "true", "description": "Incluir itens com status won (default true)" }, { "disabled": false, "key": "show_lost", "value": "true", "description": "Incluir itens com status lost (default true)" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "853591f3-ae2c-4392-a709-d050c6b7ac18", "name": "Estatísticas das etapas (stages com name, color, description, count, total_value; total_items)", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id", "stage_stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "priorities", "value": "high" }, { "key": "priorities", "value": "medium" }, { "key": "agent_id", "value": "1" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "date_start", "value": "1986-04-11T17:19:45.950Z" }, { "key": "date_end", "value": "1986-04-11T17:19:45.950Z" }, { "key": "show_won", "value": "true" }, { "key": "show_lost", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"stages\": {\n \"lead\": {\n \"name\": \"Lead\",\n \"color\": \"#3b82f6\",\n \"description\": null,\n \"count\": 5,\n \"total_value\": 5000\n },\n \"prospect\": {\n \"name\": \"Prospecto\",\n \"color\": \"#f59e0b\",\n \"description\": null,\n \"count\": 3,\n \"total_value\": 3000\n },\n \"customer\": {\n \"name\": \"Cliente\",\n \"color\": \"#10b981\",\n \"description\": null,\n \"count\": 2,\n \"total_value\": 2000\n }\n },\n \"total_items\": 10\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6cb2f96-bd66-4057-9e58-0373ddf3a9aa", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "funnels", ":id", "stage_stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "priorities", "value": "high" }, { "key": "priorities", "value": "medium" }, { "key": "agent_id", "value": "1" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "date_start", "value": "1986-04-11T17:19:45.950Z" }, { "key": "date_end", "value": "1986-04-11T17:19:45.950Z" }, { "key": "show_won", "value": "true" }, { "key": "show_lost", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do funil" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "daa8e2ae-be00-4cf0-b912-6e802f2f1bda", "name": "Ofertas", "description": { "content": "Operações relacionadas às ofertas", "type": "text/plain" }, "item": [ { "id": "e109c18e-c131-4dd0-813c-2db84d513e79", "name": "Listar ofertas", "request": { "name": "Listar ofertas", "description": { "content": "Retorna todas as ofertas da conta", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ab8bad57-41dd-48ac-98d7-e640f5587332", "name": "Lista de ofertas retornada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 123,\n \"title\": \"Oferta Black Friday\",\n \"value\": \"99.9\",\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"offer_group_name\": \"Grupo Principal\",\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n },\n \"created_at\": \"2026-04-07T10:11:12.000Z\",\n \"updated_at\": \"2026-04-07T10:11:12.000Z\",\n \"image_url\": null,\n \"usage_items_count\": 4\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ecdc17a-586e-431c-8c48-e99bf1322a95", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa2061ea-010a-4689-9b00-5828bb255816", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "163ccdbc-5273-43c4-8dd3-c65ae5fc6f7a", "name": "Criar oferta", "request": { "name": "Criar oferta", "description": { "content": "Cria uma nova oferta para a conta", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta Black Friday\",\n \"value\": 99.9,\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f24ed4fd-5982-4b98-91a1-fc1d2de71a4e", "name": "Oferta criada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta Black Friday\",\n \"value\": 99.9,\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 124,\n \"title\": \"Nova Oferta\",\n \"value\": \"129.9\",\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/nova-oferta\",\n \"offer_group_id\": 10,\n \"offer_group_name\": \"Grupo Principal\",\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2\n ]\n },\n \"created_at\": \"2026-04-07T10:20:00.000Z\",\n \"updated_at\": \"2026-04-07T10:20:00.000Z\",\n \"image_url\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7054d4e-4869-4732-9f87-d397a3ecf9a8", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta Black Friday\",\n \"value\": 99.9,\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fe9f385-8e2c-476d-b527-6bcd16188f3d", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta Black Friday\",\n \"value\": 99.9,\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "494c54ac-a042-49f0-a0ab-6b856a896e02", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta Black Friday\",\n \"value\": 99.9,\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1abe743b-22dd-41b3-9fb9-8e92576a4f83", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta Black Friday\",\n \"value\": 99.9,\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6af6c40-e9cd-4b49-8c20-8bc582478186", "name": "Buscar ofertas por texto", "request": { "name": "Buscar ofertas por texto", "description": { "content": "Retorna ofertas que correspondem ao texto pesquisado", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "offers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "black", "description": "(Required) Texto para busca" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c9a65fb3-c312-4242-bd46-2d8599f62cb7", "name": "Lista de ofertas filtradas retornada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "black" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": 123,\n \"title\": \"Oferta Black Friday\",\n \"value\": \"99.9\",\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"offer_group_name\": \"Grupo Principal\",\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n },\n \"created_at\": \"2026-04-07T10:11:12.000Z\",\n \"updated_at\": \"2026-04-07T10:11:12.000Z\",\n \"image_url\": null\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d689fd12-d0f9-48f8-bb33-94081decb8dd", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "black" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36851a8d-e2bb-4922-9be8-5224513f9952", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "black" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67e86a59-74a3-444b-a7f0-d923bf0554ac", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "black" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c27e9b87-06c0-49ca-8cb9-c4fcbe440c02", "name": "Buscar oferta por ID", "request": { "name": "Buscar oferta por ID", "description": { "content": "Retorna os dados de uma oferta específica", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "2bdd42ee-ce44-4b23-b0bd-41d879c75fea", "name": "Oferta encontrada", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123,\n \"title\": \"Oferta Black Friday\",\n \"value\": \"99.9\",\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/produto\",\n \"offer_group_id\": 10,\n \"offer_group_name\": \"Grupo Principal\",\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 2,\n 3\n ]\n },\n \"created_at\": \"2026-04-07T10:11:12.000Z\",\n \"updated_at\": \"2026-04-07T10:11:12.000Z\",\n \"image_url\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c04728f1-9a17-40f4-be99-d834fdd8d2ee", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f25233b3-cd94-478d-90fc-54074b12e446", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfc7315f-e942-4268-893f-d320ca15017b", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "59ae0411-8eb1-4561-8de3-b132067fce9f", "name": "Atualizar oferta", "request": { "name": "Atualizar oferta", "description": { "content": "Atualiza os dados de uma oferta existente", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "017e4f42-f368-490a-ba2b-570b026278da", "name": "Oferta atualizada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 123,\n \"title\": \"Oferta atualizada\",\n \"value\": \"149.9\",\n \"currency\": \"BRL\",\n \"type\": \"main\",\n \"product_link\": \"https://exemplo.com/oferta-atualizada\",\n \"offer_group_id\": null,\n \"offer_group_name\": null,\n \"additional_data\": {\n \"orderbump_offer_ids\": [\n 3,\n 4\n ]\n },\n \"created_at\": \"2026-04-07T10:11:12.000Z\",\n \"updated_at\": \"2026-04-07T10:25:00.000Z\",\n \"image_url\": null\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1346dc-82d8-4f41-9257-427642f828fd", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "201e0870-8993-424f-8844-06910a070bc3", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19bc497-25aa-4d78-9b0e-2194438530ad", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03959d20-2d2a-409b-a21e-e39f7f39bc93", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "354df3ee-75a3-4bcd-a7da-9b6a33cef025", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"offer\": {\n \"title\": \"Oferta atualizada\",\n \"value\": 129.9,\n \"offer_group_id\": null\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "33e0c93f-95a0-41cc-9b0b-d52b15de71e6", "name": "Deletar oferta", "request": { "name": "Deletar oferta", "description": { "content": "Exclui uma oferta existente", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "e7ea7e3b-b1e3-401b-92f2-681f0fc664ff", "name": "Oferta deletada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "47f22fda-ac6f-4b7a-a940-3988f295c03a", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0515a162-0bae-4235-8b9e-c093cb653f49", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49c97edb-064c-4f32-8ad5-6b601c812a1b", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "offers", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "123", "key": "id", "description": "(Required) ID da oferta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "15a9ba86-f4af-407a-8e61-8080978e76e6", "name": "Itens Kanban", "description": { "content": "Operações relacionadas aos itens do Kanban", "type": "text/plain" }, "item": [ { "id": "470c3ae0-e635-4177-bdc5-3926e007f5f9", "name": "Listar kanban items", "request": { "name": "Listar kanban items", "description": { "content": "Retorna todos os itens do Kanban com paginação e filtros", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "funnel_id", "value": "1", "description": "(Required) ID do funil" }, { "disabled": false, "key": "stage_id", "value": "lead", "description": "ID da etapa para filtrar" }, { "disabled": false, "key": "agent_id", "value": "1", "description": "ID do agente para filtrar" }, { "disabled": false, "key": "conversation", "value": "123", "description": "ID da conversa (display_id) para filtrar itens vinculados a essa conversa" }, { "disabled": false, "key": "page", "value": "1", "description": "Número da página (padrão: 1)" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "af40c967-e6a2-4b89-bfe3-a90e7508f0f4", "name": "Lista de kanban items com paginação", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "1" }, { "key": "stage_id", "value": "lead" }, { "key": "agent_id", "value": "1" }, { "key": "conversation", "value": "123" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"position\": 1,\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"priority\": \"high\",\n \"value\": 1000\n }\n }\n ],\n \"pagination\": {\n \"current_page\": 1,\n \"total_count\": 50,\n \"has_more\": true,\n \"items_per_page\": 50\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "003be822-da91-4d92-87fd-61c0a68204e6", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "1" }, { "key": "stage_id", "value": "lead" }, { "key": "agent_id", "value": "1" }, { "key": "conversation", "value": "123" }, { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d11ac35c-1fe2-4986-9213-dce8edfb896e", "name": "Criar kanban item", "request": { "name": "Criar kanban item", "description": { "content": "Cria um novo item no Kanban", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"open\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"conversation_id\": 123\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "81fc8e23-c8d7-4b9b-bd72-fc0616faca4c", "name": "Kanban item criado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"open\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"conversation_id\": 123\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c92632-2d03-44be-bcd3-c2a5d1c6c2bd", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"open\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"conversation_id\": 123\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4acc3edd-79cb-474b-82c5-c721a957aeae", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"open\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"conversation_id\": 123\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26c7287e-abe0-4d6a-8cf1-557740853686", "name": "Reordenar kanban items", "request": { "name": "Reordenar kanban items", "description": { "content": "Reordena os itens do Kanban em suas respectivas etapas", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"positions\": [\n {\n \"id\": 1,\n \"position\": 1,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 2,\n \"position\": 2,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 3,\n \"position\": 1,\n \"funnel_stage\": \"prospect\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0d663d26-8b4a-4248-b9d1-585a59fd7c71", "name": "Items reordenados com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"positions\": [\n {\n \"id\": 1,\n \"position\": 1,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 2,\n \"position\": 2,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 3,\n \"position\": 1,\n \"funnel_stage\": \"prospect\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f19bc409-ef32-416a-b021-517d743f1742", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"positions\": [\n {\n \"id\": 1,\n \"position\": 1,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 2,\n \"position\": 2,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 3,\n \"position\": 1,\n \"funnel_stage\": \"prospect\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7b9793b-f0c9-4c3e-b708-f955caac06ea", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "reorder" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"positions\": [\n {\n \"id\": 1,\n \"position\": 1,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 2,\n \"position\": 2,\n \"funnel_stage\": \"lead\"\n },\n {\n \"id\": 3,\n \"position\": 1,\n \"funnel_stage\": \"prospect\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "38446a27-024a-4d7b-8d85-6141c1d5b94e", "name": "Obter kanban item", "request": { "name": "Obter kanban item", "description": { "content": "Retorna detalhes de um item específico com cache", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "627a1dc1-5b21-495b-b1f6-4cc07abb34ad", "name": "Kanban item encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "970ad86d-228b-4767-849e-d5e9a13fd47f", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5760a0b3-41e6-48c5-b4e4-79908fcd7ac5", "name": "Atualizar kanban item", "request": { "name": "Atualizar kanban item", "description": { "content": "Atualiza um item do Kanban", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_stage\": \"prospect\",\n \"position\": 2,\n \"item_details\": {\n \"title\": \"Lead Atualizado\",\n \"priority\": \"medium\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "46777f62-eea3-4932-9730-da30dba71193", "name": "Kanban item atualizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_stage\": \"prospect\",\n \"position\": 2,\n \"item_details\": {\n \"title\": \"Lead Atualizado\",\n \"priority\": \"medium\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d8edda4-459f-4d6e-a031-2d35ee954963", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_stage\": \"prospect\",\n \"position\": 2,\n \"item_details\": {\n \"title\": \"Lead Atualizado\",\n \"priority\": \"medium\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "287d910f-39f3-4b42-9198-fb7ec25c6104", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_stage\": \"prospect\",\n \"position\": 2,\n \"item_details\": {\n \"title\": \"Lead Atualizado\",\n \"priority\": \"medium\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cefce179-7b20-4caa-8fb1-93e8eb7bd5e6", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"kanban_item\": {\n \"funnel_stage\": \"prospect\",\n \"position\": 2,\n \"item_details\": {\n \"title\": \"Lead Atualizado\",\n \"priority\": \"medium\"\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc0f44c5-7b0b-4a24-b1ae-4c25fc6df884", "name": "Excluir kanban item", "request": { "name": "Excluir kanban item", "description": { "content": "Exclui um item do Kanban", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c1e8beb5-8272-45a5-8593-f35f7298af7b", "name": "Kanban item excluído com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5abaf4d2-a3cf-4fab-b40b-b5cd4dc1c7d0", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32a8ddb7-3bc9-47a5-a1e1-62a35f3ecacf", "name": "Mover item para etapa", "request": { "name": "Mover item para etapa", "description": { "content": "Move um item do Kanban para uma etapa específica", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move_to_stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "funnel_stage", "value": "prospect", "description": "(Required) Nova etapa do item" }, { "disabled": false, "key": "funnel_id", "value": "1", "description": "ID do funil" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "578c504b-17c3-4f31-8b58-dd38cba24e3f", "name": "Item movido para etapa com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move_to_stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_stage", "value": "prospect" }, { "key": "funnel_id", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b2b5ad77-c0a5-4bf9-ba6e-9a684824661a", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move_to_stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_stage", "value": "prospect" }, { "key": "funnel_id", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e33450aa-335e-4c70-b44c-854e49f95b70", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move_to_stage" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_stage", "value": "prospect" }, { "key": "funnel_id", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2eb75e45-cd02-4c60-81eb-fae8c8fa7ad9", "name": "Mover item", "request": { "name": "Mover item", "description": { "content": "Move um item do Kanban para outro funil/etapa", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "funnel_id", "value": "1", "description": "(Required) ID do funil de destino" }, { "disabled": false, "key": "funnel_stage", "value": "prospect", "description": "(Required) Etapa de destino" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "id": "320d95e4-6458-4773-83dc-d9c04a63470b", "name": "Item movido com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "1" }, { "key": "funnel_stage", "value": "prospect" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dd24847-31a4-4189-9f73-7f1262088cd0", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "1" }, { "key": "funnel_stage", "value": "prospect" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "887af4c9-9141-47bd-9075-f91c01378d2b", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "move" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "1" }, { "key": "funnel_stage", "value": "prospect" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1228e4c3-9b46-40dd-8196-61495cdaec2c", "name": "Mudar status", "request": { "name": "Mudar status", "description": { "content": "Muda o status do kanban item (won, lost, open)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "change_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"status\": \"won\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "690c82db-b85a-4001-bd19-c3da01b8d503", "name": "Status alterado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "change_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"won\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee15f84e-2e3e-47e5-bfbd-f9b49f011f88", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "change_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"won\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfe4fb7f-89bd-4aca-ab33-5244a9283ca9", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "change_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"won\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d14dea4-b015-426b-92e6-1183c049cbec", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "change_status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"won\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3232e026-6c7b-4a24-8622-9e2ac9b59c0e", "name": "Relatórios de kanban items", "request": { "name": "Relatórios de kanban items", "description": { "content": "Retorna métricas e relatórios dos itens (from, to, funnel_id, channel, user_ids[])", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "funnel_id", "value": "2" }, { "disabled": false, "key": "from", "value": "1711929600", "description": "Timestamp início (segundos ou milissegundos)" }, { "disabled": false, "key": "to", "value": "1714521600", "description": "Timestamp fim (segundos ou milissegundos)" }, { "disabled": false, "key": "channel", "value": "Whatsapp", "description": "Canal para filtrar relatórios (ex: Whatsapp)" }, { "disabled": false, "key": "user_ids", "value": "5", "description": "IDs dos agentes para filtrar (ex: user_ids[]=5&user_ids[]=9)" }, { "disabled": false, "key": "user_ids", "value": "9", "description": "IDs dos agentes para filtrar (ex: user_ids[]=5&user_ids[]=9)" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "67573c62-0114-4ca3-a53c-46a7b38c4489", "name": "Métricas de relatório", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "2" }, { "key": "from", "value": "1711929600" }, { "key": "to", "value": "1714521600" }, { "key": "channel", "value": "Whatsapp" }, { "key": "user_ids", "value": "5" }, { "key": "user_ids", "value": "9" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"date_range\": {\n \"from\": 1711929600,\n \"to\": 1714521600\n },\n \"filters\": {\n \"funnel_id\": 2,\n \"channel\": \"Whatsapp\",\n \"user_ids\": [\n 5,\n 9\n ]\n },\n \"totals\": {\n \"total_items\": 42,\n \"won_items\": 10,\n \"lost_items\": 6,\n \"open_items\": 26,\n \"total_value\": 12500.75\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7f34d47-d733-4840-8278-4229a671227d", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "2" }, { "key": "from", "value": "1711929600" }, { "key": "to", "value": "1714521600" }, { "key": "channel", "value": "Whatsapp" }, { "key": "user_ids", "value": "5" }, { "key": "user_ids", "value": "9" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afd0fcc6-a0a5-4814-b229-237bff47cb2d", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "reports" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "2" }, { "key": "from", "value": "1711929600" }, { "key": "to", "value": "1714521600" }, { "key": "channel", "value": "Whatsapp" }, { "key": "user_ids", "value": "5" }, { "key": "user_ids", "value": "9" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e2837824-8185-4b1f-b2cc-6aca4e948ab5", "name": "Buscar kanban items", "request": { "name": "Buscar kanban items", "description": { "content": "Busca itens por texto (title, description, customer_name, customer_email)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "cliente", "description": "(Required) " }, { "disabled": false, "key": "funnel_id", "value": "4630" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "037544e5-b2c2-4728-9c09-5721c9e57c14", "name": "Lista de itens encontrados", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "cliente" }, { "key": "funnel_id", "value": "4630" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"locale\": {\n \"value\": \"\"\n }\n },\n \"custom_attributes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"offers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"deadline_at\": \"1989-11-17T04:25:13.293Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1965-12-30T11:18:58.481Z\",\n \"activities\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_id\": 5425,\n \"notes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"assigned_agents\": [\n 2343,\n 686\n ],\n \"custom_attributes\": {\n \"key_0\": 9877\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n },\n {\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"locale\": {\n \"value\": \"\"\n }\n },\n \"custom_attributes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"offers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"deadline_at\": \"2003-12-06T06:16:28.163Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"2008-08-05T15:21:24.837Z\",\n \"activities\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_id\": 4983,\n \"notes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"assigned_agents\": [\n 5742,\n 4192\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n }\n ],\n \"total\": 8299,\n \"query\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce03a9b0-4e47-4504-9a3c-935b330e0640", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "cliente" }, { "key": "funnel_id", "value": "4630" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "454685f8-d336-43c3-b5fb-94d1778f5df6", "name": "Filtrar kanban items", "request": { "name": "Filtrar kanban items", "description": { "content": "Filtra itens por prioridades, valor, agente, conversa, datas (priorities, value_min, value_max, agent_id, conversation, date_start, date_end, scheduled_date_start, scheduled_date_end)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "funnel_id", "value": "4630" }, { "disabled": false, "key": "priorities", "value": "string" }, { "disabled": false, "key": "priorities", "value": "string" }, { "disabled": false, "key": "value_min", "value": "3074.5223851301052" }, { "disabled": false, "key": "value_max", "value": "3074.5223851301052" }, { "disabled": false, "key": "agent_id", "value": "4630" }, { "disabled": false, "key": "conversation", "value": "123", "description": "ID da conversa (display_id) para filtrar itens vinculados a essa conversa" }, { "disabled": false, "key": "date_start", "value": "2013-08-19" }, { "disabled": false, "key": "date_end", "value": "2013-08-19" }, { "disabled": false, "key": "scheduled_date_start", "value": "2013-08-19" }, { "disabled": false, "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "90f78a7c-07d8-41e6-9f1f-aa691a270a4c", "name": "Lista de itens filtrados", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "4630" }, { "key": "priorities", "value": "string" }, { "key": "priorities", "value": "string" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "agent_id", "value": "4630" }, { "key": "conversation", "value": "123" }, { "key": "date_start", "value": "2013-08-19" }, { "key": "date_end", "value": "2013-08-19" }, { "key": "scheduled_date_start", "value": "2013-08-19" }, { "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"locale\": {\n \"value\": \"\"\n }\n },\n \"custom_attributes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"offers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"deadline_at\": \"2015-09-24T00:31:38.726Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"2021-06-19T23:48:11.678Z\",\n \"activities\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_id\": 9286,\n \"notes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"assigned_agents\": [\n 2362,\n 3831\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n },\n {\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": {\n \"value\": \"\"\n },\n \"code\": {\n \"value\": \"\"\n },\n \"locale\": {\n \"value\": \"\"\n }\n },\n \"custom_attributes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"offers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"deadline_at\": \"1960-07-28T20:08:33.609Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1979-09-27T01:18:19.308Z\",\n \"activities\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"conversation_id\": 8643,\n \"notes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"text\": {\n \"value\": \"\"\n },\n \"completed\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n },\n \"position\": {\n \"value\": \"\"\n },\n \"agent_id\": {\n \"value\": \"\"\n }\n }\n ],\n \"assigned_agents\": [\n 2010,\n 6575\n ],\n \"custom_attributes\": {\n \"key_0\": 4138,\n \"key_1\": 7766\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n }\n ],\n \"total\": 9967,\n \"filters\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a817f234-7f5d-4045-a13d-c27541cfe386", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "4630" }, { "key": "priorities", "value": "string" }, { "key": "priorities", "value": "string" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "agent_id", "value": "4630" }, { "key": "conversation", "value": "123" }, { "key": "date_start", "value": "2013-08-19" }, { "key": "date_end", "value": "2013-08-19" }, { "key": "scheduled_date_start", "value": "2013-08-19" }, { "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba56511a-a350-4f97-9b75-b6adaec5b7d3", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "filter" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "4630" }, { "key": "priorities", "value": "string" }, { "key": "priorities", "value": "string" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "agent_id", "value": "4630" }, { "key": "conversation", "value": "123" }, { "key": "date_start", "value": "2013-08-19" }, { "key": "date_end", "value": "2013-08-19" }, { "key": "scheduled_date_start", "value": "2013-08-19" }, { "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c67a4198-7a67-441e-b857-1c2819ad2c57", "name": "Exportar kanban items (CSV)", "request": { "name": "Exportar kanban items (CSV)", "description": { "content": "Exporta itens do funil em CSV (funnel_id obrigatório; filtros opcionais)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "funnel_id", "value": "4630", "description": "(Required) " }, { "disabled": false, "key": "priorities", "value": "string" }, { "disabled": false, "key": "priorities", "value": "string" }, { "disabled": false, "key": "value_min", "value": "3074.5223851301052" }, { "disabled": false, "key": "value_max", "value": "3074.5223851301052" }, { "disabled": false, "key": "agent_id", "value": "4630" }, { "disabled": false, "key": "date_start", "value": "2013-08-19" }, { "disabled": false, "key": "date_end", "value": "2013-08-19" }, { "disabled": false, "key": "scheduled_date_start", "value": "2013-08-19" }, { "disabled": false, "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "auth": null }, "response": [ { "id": "e57c3a02-f626-4688-bd3e-63e082d93385", "name": "Arquivo CSV", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "4630" }, { "key": "priorities", "value": "string" }, { "key": "priorities", "value": "string" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "agent_id", "value": "4630" }, { "key": "date_start", "value": "2013-08-19" }, { "key": "date_end", "value": "2013-08-19" }, { "key": "scheduled_date_start", "value": "2013-08-19" }, { "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/csv" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2eed21b8-ac92-4d3f-a031-400827f0db29", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "4630" }, { "key": "priorities", "value": "string" }, { "key": "priorities", "value": "string" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "agent_id", "value": "4630" }, { "key": "date_start", "value": "2013-08-19" }, { "key": "date_end", "value": "2013-08-19" }, { "key": "scheduled_date_start", "value": "2013-08-19" }, { "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e02b375-2af8-42ad-a88d-c104c4b82db6", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "funnel_id", "value": "4630" }, { "key": "priorities", "value": "string" }, { "key": "priorities", "value": "string" }, { "key": "value_min", "value": "3074.5223851301052" }, { "key": "value_max", "value": "3074.5223851301052" }, { "key": "agent_id", "value": "4630" }, { "key": "date_start", "value": "2013-08-19" }, { "key": "date_end", "value": "2013-08-19" }, { "key": "scheduled_date_start", "value": "2013-08-19" }, { "key": "scheduled_date_end", "value": "2013-08-19" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "670c996c-95f2-4771-9908-4e8d1d02175f", "name": "Importar kanban items (CSV)", "request": { "name": "Importar kanban items (CSV)", "description": { "content": "Importa itens a partir de CSV (funnel_id, file, mappings, default_stage_id)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "funnel_id", "value": "1421", "type": "text", "description": "" }, { "key": "default_stage_id", "value": "string", "type": "text", "description": "" }, { "key": "mappings", "value": "{\"key_0\":\"string\",\"key_1\":\"string\"}", "type": "text", "description": "" }, { "key": "file", "type": "file", "description": "" } ] } }, "response": [ { "id": "6f27b6c2-6c92-4ee5-8330-de2eaa2a3f6d", "name": "Resultado da importação (created_count, error_count, errors)", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "funnel_id", "value": "1421", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "default_stage_id", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "mappings", "value": "{\"key_0\":\"string\",\"key_1\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"created_count\": 3687,\n \"error_count\": 9546,\n \"total_rows\": 7746\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1c0230e-cad8-4043-9181-2b32bdb64fec", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "funnel_id", "value": "1421", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "default_stage_id", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "mappings", "value": "{\"key_0\":\"string\",\"key_1\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c0b2fc7-91e3-430d-9f08-a4ea15a4cb17", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "funnel_id", "value": "1421", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "default_stage_id", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "mappings", "value": "{\"key_0\":\"string\",\"key_1\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91a8cf6f-9214-4d4d-a417-5f6504c8e53c", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "import" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "", "type": "text/plain" }, "key": "funnel_id", "value": "1421", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "default_stage_id", "value": "string", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "mappings", "value": "{\"key_0\":\"string\",\"key_1\":\"string\"}", "type": "text" }, { "description": { "content": "", "type": "text/plain" }, "key": "file", "type": "file" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "442f0b0c-20dd-4019-a1fc-d254a0d6dce3", "name": "Mover múltiplos itens de etapa", "request": { "name": "Mover múltiplos itens de etapa", "description": { "content": "Move vários itens para uma nova etapa (item_ids, new_stage, funnel_id opcional)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_move_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 1,\n 2,\n 3\n ],\n \"new_stage\": \"prospect\",\n \"funnel_id\": 1098\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f9ad84a3-9f58-4b8a-a92f-087a3b6bef96", "name": "moved_count, total_requested, errors, new_stage", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_move_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 1,\n 2,\n 3\n ],\n \"new_stage\": \"prospect\",\n \"funnel_id\": 5378\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"moved_count\": 6349,\n \"total_requested\": 7349,\n \"new_stage\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3ff4a28-dce9-4641-9574-26449a44076e", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_move_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 1,\n 2,\n 3\n ],\n \"new_stage\": \"prospect\",\n \"funnel_id\": 5378\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eeaa4c5-0798-4979-a9ab-88e9e18d73bc", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_move_items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 1,\n 2,\n 3\n ],\n \"new_stage\": \"prospect\",\n \"funnel_id\": 5378\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "53e77103-a6c2-4185-8c63-4608f8857114", "name": "Atribuir agente em massa", "request": { "name": "Atribuir agente em massa", "description": { "content": "Atribui um agente a múltiplos itens (item_ids, agent_id, mode: replace ou add)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 8256,\n 3818\n ],\n \"agent_id\": 38,\n \"mode\": \"replace\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c78b9842-6df1-4a40-8f28-a41497cbd25d", "name": "assigned_count, total_requested, errors, agent_id, agent_name, mode", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 9310,\n 7560\n ],\n \"agent_id\": 9630,\n \"mode\": \"replace\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e95b92f9-a58b-4535-93de-e1226f70fcc7", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 9310,\n 7560\n ],\n \"agent_id\": 9630,\n \"mode\": \"replace\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dd33e19-a78a-49be-ad2c-827687ff2efa", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 9310,\n 7560\n ],\n \"agent_id\": 9630,\n \"mode\": \"replace\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adc8d497-6616-4ea9-bdae-4adce68aacc5", "name": "Definir prioridade em massa", "request": { "name": "Definir prioridade em massa", "description": { "content": "Aplica prioridade a múltiplos itens (item_ids, priority: high, medium, low, urgent, none)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_set_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 9602,\n 3661\n ],\n \"priority\": \"medium\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f3afe4d5-c3f4-408a-9eb3-1537b07fce83", "name": "updated_count, total_requested, errors, priority", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_set_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 8003,\n 6340\n ],\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a773259f-3350-4914-9d78-05cb049466bd", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_set_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 8003,\n 6340\n ],\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cbef38d-4a4f-4612-bf4f-5a860a769be9", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", "bulk_set_priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"item_ids\": [\n 8003,\n 6340\n ],\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ab8cb6e-e2bf-43cf-ae89-ad4d2b2bb78f", "name": "Relatório de tempo do item", "request": { "name": "Relatório de tempo do item", "description": { "content": "Retorna tempo total gasto no item (timer_duration + sessão atual se timer rodando)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "time_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "183b64d3-993c-4901-9927-cb5fe7269a77", "name": "item_id, total_duration_seconds, total_duration_formatted, timer_started_at, is_timer_running", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "time_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8469b631-1d7f-4e04-a761-db781fafae52", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "time_report" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f86a44b-c39b-4f9f-a587-4dc0bc8b4434", "name": "Tempo por etapa", "request": { "name": "Tempo por etapa", "description": { "content": "Retorna o tempo gasto em cada etapa do funil para o item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "stage_time_breakdown" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9bca0fc0-40d7-40a8-9d6c-a8cd9ae2f43a", "name": "item_id, stage_breakdown, total_stages", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "stage_time_breakdown" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f2e93d9-110c-4af2-888a-e5592384ff35", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "stage_time_breakdown" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4449a740-89c0-4371-bbc8-3c0a73d17da5", "name": "Contagens do item", "request": { "name": "Contagens do item", "description": { "content": "Retorna contagem de notas, checklist e anexos", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "f9ee97fd-06b4-4da4-94a4-d38bc62c3ed2", "name": "item_id, notes_count, checklist_count, attachments_count", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"item_id\": 123,\n \"notes_count\": 8,\n \"checklist_count\": 14,\n \"attachments_count\": 3\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c6cb678-8a8f-4120-a7c0-6b2cab8e2bb9", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "counts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b95db9b-14c6-4859-a8b2-3d33304f3bdf", "name": "Progresso do checklist por agente", "request": { "name": "Progresso do checklist por agente", "description": { "content": "Retorna progresso do checklist agrupado por agente atribuído", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "checklist_progress_by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "edbe8306-e13f-42af-b351-1c4ce3bc5837", "name": "item_id, checklist_total_items, progress_by_agent, summary", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "checklist_progress_by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"item_id\": 123,\n \"checklist_total_items\": 10,\n \"progress_by_agent\": [\n {\n \"agent_id\": 5,\n \"completed\": 4,\n \"pending\": 1\n },\n {\n \"agent_id\": 9,\n \"completed\": 2,\n \"pending\": 3\n }\n ],\n \"summary\": {\n \"completed\": 6,\n \"pending\": 4\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14adf1a8-931b-4478-b4df-ef4583fa6571", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "checklist_progress_by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "88cfb1d4-9806-411d-8e8c-2a29ebba63df", "name": "Checklist", "description": { "content": "Operações relacionadas ao checklist", "type": "text/plain" }, "item": [ { "id": "54de4763-d9b7-44c4-a79d-1de3e8aed15a", "name": "Criar item do checklist", "request": { "name": "Criar item do checklist", "description": { "content": "Adiciona um novo item ao checklist do kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"text\": \"Fazer follow-up com o cliente\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5c8f66d0-5da8-46ed-9795-08f1a1eea770", "name": "Item do checklist criado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"Fazer follow-up com o cliente\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7cc274ed-0af4-4886-9e86-b14aeaa23192", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"Fazer follow-up com o cliente\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92485dd7-c90d-4f45-86db-1c025326be66", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"Fazer follow-up com o cliente\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e0a5eebf-2685-47ca-8c29-0c426588050d", "name": "Atribuir agente ao item do checklist", "request": { "name": "Atribuir agente ao item do checklist", "description": { "content": "Atribui um agente a um item específico do checklist", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent_to_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\",\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c34783cf-f303-4325-8617-55b628892034", "name": "Agente atribuído ao item do checklist", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent_to_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\",\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "736b1099-566c-42e2-a949-f4438804771b", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent_to_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\",\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfa05bff-4dae-4256-ac2a-365a13177432", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent_to_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\",\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b21ba348-2b8e-4e92-b999-821da603b7e1", "name": "Remover agente do item do checklist", "request": { "name": "Remover agente do item do checklist", "description": { "content": "Remove um agente de um item específico do checklist", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent_from_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4a0398c2-df44-4dc0-bb12-05a16f8feca5", "name": "Agente removido do item do checklist", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent_from_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2dac355-5a81-42f4-8594-253efd39436f", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent_from_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "473e8257-5c20-413e-912c-fa227f31b022", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent_from_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"uuid-123\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "caced289-4b04-43b9-a36e-36fb722a815d", "name": "Listar checklist do item", "request": { "name": "Listar checklist do item", "description": { "content": "Retorna o checklist do kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "get_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "fab83530-d418-4ddb-96a0-7f28f1f7f9ef", "name": "item_id, checklist, checklist_count", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "get_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"item_id\": 4567,\n \"checklist_count\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "131e4b80-6909-4f0f-9ddb-3160e594fa5d", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "get_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae8de54d-4e5c-4f51-a4df-31c9423b05a9", "name": "Excluir item do checklist", "request": { "name": "Excluir item do checklist", "description": { "content": "Remove um item do checklist (checklist_item_id)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "delete_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "checklist_item_id", "value": "string", "description": "(Required) " } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "7c53ac0d-d0b2-432e-9af8-a9bbf84f7021", "name": "Kanban item atualizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "delete_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checklist_item_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee7d303-1e27-4b85-bb0a-640c3df06bbc", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "delete_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "checklist_item_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6b0c2ce4-7e92-464b-a511-c31327199a7e", "name": "Atualizar item do checklist", "request": { "name": "Atualizar item do checklist", "description": { "content": "Atualiza um item do checklist (checklist_item_id; text, due_date, priority, agent_id, linked_*)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\",\n \"text\": \"string\",\n \"due_date\": \"1951-09-30T20:22:49.607Z\",\n \"priority\": \"string\",\n \"agent_id\": 6993,\n \"linked_item_id\": 9485,\n \"linked_conversation_id\": 3008,\n \"linked_contact_id\": 895\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7e80ad31-7646-4a12-8c92-1c007adddfa6", "name": "Kanban item atualizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\",\n \"text\": \"string\",\n \"due_date\": \"1951-09-30T20:22:49.607Z\",\n \"priority\": \"string\",\n \"agent_id\": 6993,\n \"linked_item_id\": 9485,\n \"linked_conversation_id\": 3008,\n \"linked_contact_id\": 895\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a245b5b2-3eee-4297-b0dd-fec4542bac5c", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\",\n \"text\": \"string\",\n \"due_date\": \"1951-09-30T20:22:49.607Z\",\n \"priority\": \"string\",\n \"agent_id\": 6993,\n \"linked_item_id\": 9485,\n \"linked_conversation_id\": 3008,\n \"linked_contact_id\": 895\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d295efca-a8e8-4f60-b663-4fec393e733a", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\",\n \"text\": \"string\",\n \"due_date\": \"1951-09-30T20:22:49.607Z\",\n \"priority\": \"string\",\n \"agent_id\": 6993,\n \"linked_item_id\": 9485,\n \"linked_conversation_id\": 3008,\n \"linked_contact_id\": 895\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dd56efd4-d762-4f5f-9caf-a2b2ffd9e261", "name": "Marcar/desmarcar item do checklist", "request": { "name": "Marcar/desmarcar item do checklist", "description": { "content": "Alterna o status completed de um item do checklist (checklist_item_id)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "toggle_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "360777d6-d687-437d-aba9-8c00ca84a678", "name": "Kanban item atualizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "toggle_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f515ecc8-31fc-40c9-a035-6dad066a89f0", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "toggle_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dc4e412-a6a9-4602-90ed-853e81c79fc7", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "toggle_checklist_item" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"checklist_item_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4e10142e-2af0-4aed-9731-ab2145ea7bdf", "name": "Duplicar checklist para outro item", "request": { "name": "Duplicar checklist para outro item", "description": { "content": "Copia o checklist deste item para outro (target_item_id; merge=true para mesclar)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "duplicate_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item origem" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"target_item_id\": 1566,\n \"merge\": \"true\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "15055c4c-d6d4-4e5f-8f2b-d98df6657fe8", "name": "source_item_id, target_item_id, duplicated_items_count, total_items_count", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "duplicate_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item origem" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_item_id\": 1566,\n \"merge\": \"true\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c094cee0-5f96-4696-af64-7732ae3eb616", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "duplicate_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item origem" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_item_id\": 1566,\n \"merge\": \"true\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e41aedc1-2002-41a3-a39b-f73b568a27fa", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "duplicate_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item origem" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"target_item_id\": 1566,\n \"merge\": \"true\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73142745-9720-42bd-bab0-7b6037d1ab28", "name": "Buscar no checklist", "request": { "name": "Buscar no checklist", "description": { "content": "Busca itens do checklist por texto (query)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "search_checklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b5bfb79e-7a1c-42e6-834b-38acb923e717", "name": "item_id, query, total_items, filtered_items, checklist", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "search_checklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99cfc5ec-6190-481c-a52d-cf3530f49b4f", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "search_checklist" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "query", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "28aab0a5-67d2-477e-ba3f-b1613255a0d8", "name": "Notas", "description": { "content": "Operações relacionadas às notas", "type": "text/plain" }, "item": [ { "id": "98987b36-39c5-455f-b3eb-a67aa116f5e1", "name": "Criar nota", "request": { "name": "Criar nota", "description": { "content": "Adiciona uma nova nota ao kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"text\": \"Cliente interessado no produto premium\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "63174f69-01d0-44f6-8614-92ebc31ae6fd", "name": "Nota criada", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"Cliente interessado no produto premium\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7ba38ad-252d-4430-b473-70391e5020a5", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"Cliente interessado no produto premium\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6725b8d8-9399-4352-90f8-99e9e3ffa2be", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "create_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"text\": \"Cliente interessado no produto premium\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99ee812d-1b62-493c-acf9-379e6508e1e5", "name": "Listar notas do item", "request": { "name": "Listar notas do item", "description": { "content": "Retorna as notas do kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "get_notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "07908f1d-590a-48d2-83db-945c92e3b744", "name": "item_id, notes, notes_count", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "get_notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"item_id\": 5469,\n \"notes_count\": 2805\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14bfdccb-f7bc-452d-8b47-52f986a6657c", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "get_notes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e9edcdd-3e35-417e-9dc8-fbfb023e7f1a", "name": "Atualizar nota", "request": { "name": "Atualizar nota", "description": { "content": "Atualiza uma nota do item (note_id no body; text, attachments, linked_item_id, linked_conversation_id, linked_contact_id)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\",\n \"text\": \"string\",\n \"linked_item_id\": 4604,\n \"linked_conversation_id\": 4860,\n \"linked_contact_id\": 562\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "799a5bbf-b341-4252-81c2-c1acc4b04982", "name": "Kanban item atualizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\",\n \"text\": \"string\",\n \"linked_item_id\": 4604,\n \"linked_conversation_id\": 4860,\n \"linked_contact_id\": 562\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "481ca450-fd42-48bb-8eb3-c62a0a0bf719", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\",\n \"text\": \"string\",\n \"linked_item_id\": 4604,\n \"linked_conversation_id\": 4860,\n \"linked_contact_id\": 562\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eeb2d6c-b2c0-4a99-805e-ea0536c7fc25", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "update_note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\",\n \"text\": \"string\",\n \"linked_item_id\": 4604,\n \"linked_conversation_id\": 4860,\n \"linked_contact_id\": 562\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9bcd65c1-bcd0-499e-a558-6ea2e02e123f", "name": "Excluir nota", "request": { "name": "Excluir nota", "description": { "content": "Remove uma nota do item (note_id no body ou query)", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "delete_note" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "note_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null, "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ce96a0e0-5a70-494a-be36-8dcb8c86f008", "name": "Kanban item atualizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "delete_note" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "note_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86b7c613-3fa8-4f35-bcb9-6242e91915bc", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "delete_note" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "note_id", "value": "string" } ], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"note_id\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c7eb550f-502e-4058-89de-2f476e940535", "name": "Mensagens Agendadas", "description": { "content": "Operações relacionadas às mensagens agendadas", "type": "text/plain" }, "item": [ { "id": "34fb98bb-1bd3-4852-a628-078108ee5157", "name": "Listar mensagens agendadas", "request": { "name": "Listar mensagens agendadas", "description": { "content": "Retorna todas as mensagens agendadas de uma conversa específica", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "37a580d5-fe0a-42ee-a222-1d00104e0dda", "name": "Lista de mensagens agendadas retornada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": 3,\n \"message\": \"TEste\",\n \"scheduled_at\": 1756302600,\n \"title\": \"Teste\",\n \"inbox_id\": 7,\n \"conversation_id\": 1918,\n \"created_at\": 1756302539,\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd05a38f-45ce-46b9-baff-62fc059edbd0", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2323bbd8-f74d-465f-930a-20d705284155", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a351c6a5-b860-4c83-a929-2b3c5bf8e77d", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f785f1ed-fd2b-479f-bfd6-c50ec9164e09", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "06c7c367-8ff4-4eb4-b18a-dd2b25f0c1c6", "name": "Criar mensagem agendada", "request": { "name": "Criar mensagem agendada", "description": { "content": "Cria uma nova mensagem agendada para uma conversa específica", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b285dea8-998e-43cc-a0f7-ffd329d08f4a", "name": "Mensagem agendada criada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3,\n \"message\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": 1756302600,\n \"title\": \"Reunião\",\n \"inbox_id\": 7,\n \"conversation_id\": 1897,\n \"created_at\": 1756302539,\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd3682e1-9afe-44b9-b973-1b0faeaf73c3", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2db75b8-b95a-4ac3-a486-6f9b7f959d18", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03f6947e-bfb3-432c-a0d1-050773ba767d", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd9c0e80-e16f-411a-9318-f08d57c59fd0", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e994c8cb-d3da-444f-bd43-98863f05801c", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"conversation_id\": 1897,\n \"inbox_id\": 7,\n \"content\": \"Lembrete: reunião às 14h\",\n \"scheduled_at\": \"2025-08-27T13:50:00.000Z\",\n \"title\": \"Reunião\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bf2bb842-8d52-416d-98e2-942d12ce66de", "name": "Atualizar mensagem agendada", "request": { "name": "Atualizar mensagem agendada", "description": { "content": "Atualiza uma mensagem agendada específica", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "7fdbb52c-b0bc-4fbf-b126-e07ab219d9f2", "name": "Mensagem agendada atualizada com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 3,\n \"message\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": 1756388400,\n \"title\": \"Título Atualizado\",\n \"inbox_id\": 7,\n \"conversation_id\": 1897,\n \"created_at\": 1756302539,\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b076392a-2765-4934-9eb7-e3796a8eb70b", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da2326c-b97e-4499-89ae-7778ca792909", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d437b90-4c92-4ebf-946d-d2443a1e540c", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f99dd387-4acf-451f-ad76-15ebf86bd632", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ff5ebec-1b8f-4469-8a7a-cf9fc5b3b865", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Novo conteúdo da mensagem\",\n \"scheduled_at\": \"2025-08-28T14:00:00.000Z\",\n \"title\": \"Título Atualizado\",\n \"status\": \"pending\",\n \"is_recurrent\": false,\n \"period\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e5cb633-340c-4ef8-b5ec-e993373acb9d", "name": "Excluir mensagem agendada", "request": { "name": "Excluir mensagem agendada", "description": { "content": "Exclui uma mensagem agendada específica", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "id": "c6d6b037-e7e0-453c-b782-1e29f511e216", "name": "Mensagem agendada excluída com sucesso", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"Mensagem agendada excluída com sucesso\",\n \"deleted_id\": 3\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d8d1b5c-d244-49dc-9f69-f5517443cc66", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "178e2097-179d-463a-83ce-7414a44a8c3c", "name": "Não autorizado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c115b46-a66c-49e4-b913-b5a423185838", "name": "Acesso negado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7e36dcb-4c18-4962-a890-465c6aac24ac", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1897", "key": "conversation_id", "description": "(Required) ID da conversa" }, { "disabled": false, "type": "any", "value": "3", "key": "id", "description": "(Required) ID da mensagem agendada" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6a4e6418-15f1-4c72-88aa-39a21bf6e850", "name": "Lead Capture", "description": { "content": "Captura de leads via formularios. Publicos + admin.", "type": "text/plain" }, "item": [ { "id": "47eac58f-6f50-4505-b3ca-a58ef4343c11", "name": "Captura de lead publico", "request": { "name": "Captura de lead publico", "description": { "content": "Recebe form. CORS. Sem auth.", "type": "text/plain" }, "url": { "path": [ "api", "leads", "capture", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"message\": \"string\",\n \"custom_attributes\": {},\n \"tracking\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "31f6c364-d43b-4719-87d5-007d4ea209e7", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "leads", "capture", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"message\": \"string\",\n \"custom_attributes\": {},\n \"tracking\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"contact_id\": 12345,\n \"conversation_id\": 67890\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "342305f2-3c64-4cd6-aad9-7c5d70814d18", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "leads", "capture", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"message\": \"string\",\n \"custom_attributes\": {},\n \"tracking\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a164a875-2c27-4aec-8d97-e6d7a548fa2e", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "leads", "capture", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"message\": \"string\",\n \"custom_attributes\": {},\n \"tracking\": {}\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "65b47566-a964-4f55-8df5-0dbad25d9889", "name": "CORS preflight", "request": { "name": "CORS preflight", "description": { "content": "Preflight.", "type": "text/plain" }, "url": { "path": [ "api", "leads", "capture", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "method": "OPTIONS", "auth": null }, "response": [ { "id": "e7e5db69-7328-4764-8b68-efbe5dde3451", "name": "OK", "originalRequest": { "url": { "path": [ "api", "leads", "capture", ":slug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "slug", "description": "(Required) " } ] }, "method": "OPTIONS", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c77c8997-9755-415e-920b-0210d1b542dd", "name": "Script JS embed", "request": { "name": "Script JS embed", "description": { "content": "JS auto-tracking.", "type": "text/plain" }, "url": { "path": [ "lead-capture.js" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "auth": null }, "response": [ { "id": "3d0bcd25-41b0-434f-ab7c-b474ef0c82d4", "name": "Sucesso", "originalRequest": { "url": { "path": [ "lead-capture.js" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "692e11f7-732c-457b-943a-ac5ec60bf4c6", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "lead-capture.js" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fcc95e2f-3a23-4ed3-945f-be942a49c1e9", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "lead-capture.js" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3220504b-bf8f-4815-b4dd-953307264148", "name": "Listar endpoints", "request": { "name": "Listar endpoints", "description": { "content": "Lista todos.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "17021f15-20a8-4496-97b0-24834ae68552", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48da51c9-1f5c-4b85-951e-97ba71618a41", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "81563581-85e4-43b9-9fe6-96746f8e01d9", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "00ef8ffd-8b63-4177-83f9-2386d5d352a8", "name": "Criar endpoint", "request": { "name": "Criar endpoint", "description": { "content": "capture_config define mapeamento.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"inbox_id\": 9680,\n \"enabled\": true,\n \"capture_config\": {},\n \"allowed_origins\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "af3fab43-2c05-4302-87d6-f08eb12785b2", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"inbox_id\": 8289,\n \"enabled\": false,\n \"capture_config\": {},\n \"allowed_origins\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29101ccd-7616-4ed8-a7fc-25c8227b69bc", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"inbox_id\": 8289,\n \"enabled\": false,\n \"capture_config\": {},\n \"allowed_origins\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "42ff20d1-f9b0-4d09-a686-77abb36f533c", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"slug\": \"string\",\n \"inbox_id\": 8289,\n \"enabled\": false,\n \"capture_config\": {},\n \"allowed_origins\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2439ab51-5738-4395-8800-5e3491317e93", "name": "Detalhe", "request": { "name": "Detalhe", "description": { "content": "Config completa.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "4aaca61c-e160-458c-a752-a6aa419224ba", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f9e3b884-2cf5-448d-82d9-37725b403ee6", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0b1def87-3c14-4dff-beeb-4e2b565715c5", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f69dcf16-4109-456e-bc00-28b6301d99c8", "name": "Atualizar", "request": { "name": "Atualizar", "description": { "content": "Atualiza config.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "216c62bc-156d-4dd1-9889-78f37ff262ca", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f1d0a98d-1dcf-420f-a060-01c15738ce79", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "aeb445ce-2042-4d57-9830-df8e27f49639", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "542548fb-d8df-4b43-8493-9e6eb9c0c1ad", "name": "Excluir", "request": { "name": "Excluir", "description": { "content": "Remove.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "adcc5379-3e15-4169-b632-9de946360084", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "92ed9ad5-db29-4808-ab22-ef2f70c53917", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c1f241ff-8b36-4bf2-a808-b0826987238d", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "lead_capture_endpoints", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "25cea74e-db65-4d05-abd1-2f2dc1ddc480", "name": "Captain (Agente IA)", "description": { "content": "Agente IA: preferencias, knowledge base, tarefas.", "type": "text/plain" }, "item": [ { "id": "cce284f5-09ae-4d66-98f4-22fac59e059b", "name": "Listar knowledge base", "request": { "name": "Listar knowledge base", "description": { "content": "PDFs/URLs/textos.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "c5c869f9-deb8-452e-81bf-f8778b76f015", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "949f1d9c-607d-4c4a-a967-d154f81eaceb", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "18ae6646-7fbe-4a13-90b2-3fb9a75c8295", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb559b0b-f25f-4207-b6b5-4571ca426fef", "name": "Adicionar ao knowledge base", "request": { "name": "Adicionar ao knowledge base", "description": { "content": "PDF/URL/texto pra Capitao usar.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"document_type\": \"text\",\n \"name\": \"string\",\n \"content\": \"string\",\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "86c8dd51-a3f0-44c2-8cfb-4d77a3de3a48", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"text\",\n \"name\": \"string\",\n \"content\": \"string\",\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76693ba3-11a1-402c-a410-f656a3d1e186", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"text\",\n \"name\": \"string\",\n \"content\": \"string\",\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d224231b-5226-420b-a735-d8c1a23ac43c", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"document_type\": \"text\",\n \"name\": \"string\",\n \"content\": \"string\",\n \"url\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8babc505-7a51-4ff1-b68c-90b340d51b7d", "name": "Detalhe do documento", "request": { "name": "Detalhe do documento", "description": { "content": "Conteudo + metadados.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "c68c0c31-f1bf-46ea-b7a3-3ea7e5fb882e", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9493be93-1165-467c-b4dd-fef42e2673b1", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e82943c1-e2cc-4273-a1db-23f562b3769c", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c37f0396-719b-4a1c-acdc-17b83ad662c4", "name": "Remover documento", "request": { "name": "Remover documento", "description": { "content": "Remove do knowledge base.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "6a32b43e-c9b8-445e-8b9f-526cdb08bd07", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b13c1637-c668-49e5-a6b4-5abf78706514", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3c1e0e7-af89-43a4-9dca-1c72424f1c8e", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "ai_agent_documents", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "15e2e2bb-cb4f-4417-9afc-70ef21e6cdc6", "name": "Disparo de Mensagens", "description": { "content": "Broadcasts em massa.", "type": "text/plain" }, "item": [ { "id": "5e1727e0-e50e-41bd-926d-15d77cfea6a2", "name": "Listar broadcasts", "request": { "name": "Listar broadcasts", "description": { "content": "Historico de disparos.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "126bc12e-c5e6-4837-a7e0-210b8009384a", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fb29dd11-f162-4a42-a357-35280eef5d3e", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "24e3c446-8868-424a-8240-b4f8dfcf0d16", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3b9c37b7-db72-424d-9198-bdb0cdfa3703", "name": "Criar broadcast", "request": { "name": "Criar broadcast", "description": { "content": "Dispara em massa. Suporta template + agendamento.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 5970,\n \"message\": \"string\",\n \"contact_ids\": [\n 7454,\n 8266\n ],\n \"template_id\": \"string\",\n \"filters\": {},\n \"scheduled_at\": \"2016-10-24T23:27:25.842Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cc5d63ba-1e52-43e5-882c-7bfed9058d37", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 30,\n \"message\": \"string\",\n \"contact_ids\": [\n 1808,\n 2935\n ],\n \"template_id\": \"string\",\n \"filters\": {},\n \"scheduled_at\": \"2013-02-13T05:09:29.878Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "29935cb6-3373-4aef-95da-92f04e7e9461", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 30,\n \"message\": \"string\",\n \"contact_ids\": [\n 1808,\n 2935\n ],\n \"template_id\": \"string\",\n \"filters\": {},\n \"scheduled_at\": \"2013-02-13T05:09:29.878Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b923a5b6-e546-4020-8b6d-739fb87d0b33", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 30,\n \"message\": \"string\",\n \"contact_ids\": [\n 1808,\n 2935\n ],\n \"template_id\": \"string\",\n \"filters\": {},\n \"scheduled_at\": \"2013-02-13T05:09:29.878Z\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a51b854c-d16e-4620-a91e-6f8f94ad7568", "name": "Detalhe do broadcast", "request": { "name": "Detalhe do broadcast", "description": { "content": "Status + estatisticas.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "5a92cffe-eebe-4552-8422-3d0283428b51", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8e692d5a-e923-4b76-9aaa-f9aee4553e87", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e25edefe-040b-43cf-bed5-7f8e0918456a", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c65fa37-0906-4353-a944-ab2f7e2a28a9", "name": "Cancelar broadcast", "request": { "name": "Cancelar broadcast", "description": { "content": "Cancela agendado.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "1738e16a-7507-4c17-be78-eca8ce0bd36a", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95a6eb62-024b-4a17-aa76-107289263b9e", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d21d05ab-b3e2-48dd-b936-13fe354c9517", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "broadcasts", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "67a21438-20b5-44a7-88b3-26baa27dd272", "name": "Listar broadcasts em grupo", "request": { "name": "Listar broadcasts em grupo", "description": { "content": "Historico em grupos WhatsApp.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "48fb926a-06ad-474c-8448-7c8bc847d76e", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cf1ea2ff-cf9a-4c9a-bbf3-0a0d8359665c", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "520fb23c-4849-46a7-81ef-ce777919e081", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ba1986db-50b7-40f9-ba88-841ff1d2965f", "name": "Disparar pra grupos WhatsApp", "request": { "name": "Disparar pra grupos WhatsApp", "description": { "content": "Multiplos grupos simultaneamente.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 3725,\n \"message\": \"string\",\n \"group_ids\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2f7323f-ccae-4f3e-a103-eacd86339114", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 9841,\n \"message\": \"string\",\n \"group_ids\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "83bb6aed-24f4-4586-8bf0-16d336c232b5", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 9841,\n \"message\": \"string\",\n \"group_ids\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a0a3998-66f3-4643-9fe2-3a87466de7ac", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "whatsapp_group_broadcasts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 9841,\n \"message\": \"string\",\n \"group_ids\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "856c37e6-74a4-4b28-849c-6b7cf08adea2", "name": "VOIP", "description": { "content": "Chamadas via WhatsApp Business.", "type": "text/plain" }, "item": [ { "id": "962b996a-e52f-4a0f-aa86-05136ba64b70", "name": "Buscar config VOIP", "request": { "name": "Buscar config VOIP", "description": { "content": "Settings globais.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "8c668ce9-51d7-467e-bd78-ad847d379105", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dc8056b2-b95c-428d-89f7-28a5c115d0bc", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ea52d835-d2c1-49ff-a760-591dca7c2c9b", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ef1dccc-bba9-42aa-aba2-38700b3f8b46", "name": "Atualizar config VOIP", "request": { "name": "Atualizar config VOIP", "description": { "content": "Atualiza settings.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6ca9a454-d3fe-4202-b931-0f8d8ac04114", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "db9071c3-4919-4539-8533-68e374569020", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e2d24f42-5aa2-4417-83cc-04e9741eb77e", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_settings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "015e68d2-b14b-461f-afbc-4f1075d8f944", "name": "Listar dispositivos VOIP", "request": { "name": "Listar dispositivos VOIP", "description": { "content": "Numeros configurados.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "f987dd45-9156-43e9-8855-1d1463ae934d", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0fe38bdd-3f48-4112-a180-3bdad8c3d17e", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e6853121-7bfc-490d-8adc-04701d2c9441", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "56f0c790-8994-4e30-8f3f-908cf11633de", "name": "Adicionar dispositivo VOIP", "request": { "name": "Adicionar dispositivo VOIP", "description": { "content": "Conecta numero. device_token do WAVOIP.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"device_token\": \"string\",\n \"phone_number\": \"string\",\n \"simultaneous_calls\": 5\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1a424262-bf21-4764-ae82-b8674af04ee3", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"string\",\n \"phone_number\": \"string\",\n \"simultaneous_calls\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "855cbc67-24d8-4862-840d-c1a2467fb248", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"string\",\n \"phone_number\": \"string\",\n \"simultaneous_calls\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "15221e9e-5d13-482a-b0c8-5328302bc45f", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"string\",\n \"phone_number\": \"string\",\n \"simultaneous_calls\": 5\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43c91183-c5a6-4270-9849-cb114d9593ac", "name": "Detalhe do dispositivo", "request": { "name": "Detalhe do dispositivo", "description": { "content": "Config + status.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "ef99e10a-cc03-4e77-9ccd-25ac4705e543", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0f8ea7a9-d505-4ac6-9d57-d45a8ebc51c4", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1d9d1ab3-d62b-4ae8-a94e-2322f2938651", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e734625-6760-4b11-802f-7b55a18c9592", "name": "Atualizar dispositivo", "request": { "name": "Atualizar dispositivo", "description": { "content": "Atualiza config.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a5cd5f76-5067-486a-a969-3cbd8a573d83", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "14696569-05db-4144-b6e9-9e35ef3b5e32", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1b93bdb4-b217-4af4-914b-1c09ffa66238", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9c7254a-0200-44cd-833e-f7c9c1dfe65c", "name": "Remover dispositivo", "request": { "name": "Remover dispositivo", "description": { "content": "Desconecta.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "2c735d72-c858-4258-b942-775e7b16a60a", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a366646a-360d-41e1-9557-00c32fd06d76", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "acd712e6-9607-4de4-85a9-cc774aad71df", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_devices", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c37dbb1c-520b-4e88-9e34-33635bbba8e0", "name": "Iniciar chamada VOIP", "request": { "name": "Iniciar chamada VOIP", "description": { "content": "Outbound call.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "voip_calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"device_id\": 4119\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "f824c599-f787-4bf6-82cd-d5330b5c0ad9", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "voip_calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_id\": 4119\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0ecdae1a-36cb-4fc7-b0bd-3cf580f22276", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "voip_calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_id\": 4119\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "264ead76-9cde-4d0e-b4f8-3bf24181d1f3", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "voip_calls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "conversation_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"device_id\": 4119\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d4db68ad-2d80-422d-81de-38113252bbda", "name": "Webhook WAVOIP", "request": { "name": "Webhook WAVOIP", "description": { "content": "Eventos do WAVOIP. Sem auth.", "type": "text/plain" }, "url": { "path": [ "webhooks", "wavoip", ":device_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_token", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fb4a48dd-64a5-4b2c-8a75-7d2522b257ea", "name": "Sucesso", "originalRequest": { "url": { "path": [ "webhooks", "wavoip", ":device_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_token", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "00681375-1302-4b4c-b0dc-e16c06e92260", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "webhooks", "wavoip", ":device_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_token", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c5a05491-dd1e-4b96-b618-3d28ce30287e", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "webhooks", "wavoip", ":device_token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "device_token", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee9b4195-4a78-4f26-8b69-071523331769", "name": "Listar SLAs", "request": { "name": "Listar SLAs", "description": { "content": "Politicas configuradas.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "44dfa9de-79ce-4a50-9fc5-6da8ee8b90d5", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6926d1ea-3dfb-4157-b3b4-7ca6eebdaac0", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d4c0a4c-4a52-427e-85e6-a9668cb99697", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f79d0cfc-4353-428c-b29e-14c61c8ab9ac", "name": "Atualizar SLA", "request": { "name": "Atualizar SLA", "description": { "content": "Atualiza thresholds.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "2e11f9ff-94fd-4553-9f1a-2cccd4d9121a", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "605e690f-ecd9-4388-9f32-4b7fa44737d7", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1914eb7c-469c-4e5e-9b7b-31edd909db51", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_sla_policies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d50f4316-1c9d-4eca-ab07-46d5061fc3ee", "name": "VOIP - Analytics", "description": { "content": "Metricas de chamadas.", "type": "text/plain" }, "item": [ { "id": "1160667e-ca20-4972-8d19-9c338fffe1ef", "name": "Funil de chamadas", "request": { "name": "Funil de chamadas", "description": { "content": "Distribuicao pelos estagios do funil.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "0dc90c4f-e1d6-459b-8e40-c626592cb095", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "76824300-55fa-4539-a668-0b73f58b13fd", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "460cd363-53e7-475b-b519-75f598ce6cd7", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "funnel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90af03b3-73db-4a04-b8a4-698eab39ac91", "name": "Financeiro", "request": { "name": "Financeiro", "description": { "content": "Valor de leads via VOIP.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "financial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "f1f7a959-f0c5-43d9-bd2b-a45f364f1922", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "financial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17827a72-c2e4-41aa-92c2-a422f7ec2099", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "financial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d4983745-759c-4a76-b98d-0a54aa94b297", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "financial" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8391f2f9-2a96-4e00-9595-08eb76cba46a", "name": "Por agente", "request": { "name": "Por agente", "description": { "content": "Metricas por atendente.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "4c80a3e7-e0fa-49e6-836d-179c90067ba5", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d9f080b7-bc58-4800-a44f-23c48ab1f2d0", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "246d17a5-6aa7-449a-afc0-c759b5902aad", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b7735881-b781-4f2c-bb15-2f89f78ab2f3", "name": "Por origem", "request": { "name": "Por origem", "description": { "content": "Metricas por origem do lead.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_origin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "48914419-cc26-4d66-8b82-dd447ebaf605", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_origin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "12b4c949-c3ed-42f9-bdca-bc6d56f7abfa", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_origin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "75b35cf0-4a16-4c22-b195-c2bdfcc042ff", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "by_origin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3189925-c5b8-44c3-bfc4-38febb5b5e06", "name": "Diario", "request": { "name": "Diario", "description": { "content": "Serie temporal diaria.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "daily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "5769779c-aaf7-457f-ba3b-60c5f3d1ca26", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "daily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f4deba38-4db1-4ce2-b9a1-386d190e4722", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "daily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "74afa557-bda0-4492-9bcd-5a11e7748e4d", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "daily" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8299117f-a8d7-4076-a024-c72280145172", "name": "Distancia geografica", "request": { "name": "Distancia geografica", "description": { "content": "Distribuicao geografica.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "distance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "9ffdedf3-e24b-4a7b-a547-b4426131e27c", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "distance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f51d8303-0e01-46c7-ab78-ae7da3bf1c8e", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "distance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "722ef398-fa88-46fc-bfe0-e954c041bf88", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "distance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95c41fe9-0cda-4f47-bd97-e3bef89fe2bf", "name": "Chamadas por lead", "request": { "name": "Chamadas por lead", "description": { "content": "Tentativas medias.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "calls_per_lead" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "c49113c2-e67c-48f3-b3cf-257011be963f", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "calls_per_lead" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3c7dbe01-f4c5-42f6-abde-3e66d2215d02", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "calls_per_lead" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3b515c17-a7bc-4422-8598-e96032871919", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "calls_per_lead" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "01273fac-79ea-43e4-8858-5bfae7f33fb1", "name": "Taxa de atendimento", "request": { "name": "Taxa de atendimento", "description": { "content": "% atendidas.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "attendance_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "f1f47dbf-2ce7-47cc-b164-dcc67fb0084b", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "attendance_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2ac796eb-d90b-4b83-ab69-4ea991b4c4b3", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "attendance_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "38a50142-4561-4bda-8468-ee46d80fc9b5", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "attendance_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26002b4a-e022-45b9-9242-aba38015a98d", "name": "Velocidade de resposta", "request": { "name": "Velocidade de resposta", "description": { "content": "Tempo entre lead e 1a chamada.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "lead_speed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "0f987b88-5c6d-4cbf-8fd3-452b1f6a3bfd", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "lead_speed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48c185fa-5571-497f-a706-da8e98faa984", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "lead_speed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1e0ff1d6-1ae7-4f8a-a662-0f69f3f77ec8", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "lead_speed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "55edc7c2-61c4-44b6-97f2-b95a522dec66", "name": "First Call Resolution", "request": { "name": "First Call Resolution", "description": { "content": "% convertidos na 1a ligacao.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "fcr_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "16a2dfd6-ff37-403e-970a-de3bf92b3b81", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "fcr_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f811cdaa-d0b3-4785-aeaa-94386c002e37", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "fcr_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9017d0d4-4249-47c9-aacc-316e7315aa3f", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "fcr_rate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "990dcf4e-885c-4573-882f-2d2def9dfe05", "name": "Checklist de setup", "request": { "name": "Checklist de setup", "description": { "content": "Status de configuracao.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "setup_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "ff452f19-89ab-4ccd-a6db-ba3b6c9ec2b8", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "setup_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c6fc24ec-7776-4cfa-a0d1-45e7c14742ed", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "setup_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bb17def0-cdaf-4cc2-8f5a-7c2f30ad5737", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "setup_checklist" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "112122c0-ced9-467a-8fe2-7f4da643803c", "name": "Comparativo", "request": { "name": "Comparativo", "description": { "content": "Compara periodos.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "compare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "733b640a-060c-42fc-9e15-f3c639433d6f", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "compare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f3572462-b1a4-4400-9011-b9f7b2966903", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "compare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "fffbfa3f-2228-4166-a88c-38d8c7148345", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "compare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd9ad3c1-96e7-40dd-a667-6b098e1ea9f3", "name": "Resumos recentes", "request": { "name": "Resumos recentes", "description": { "content": "Ultimas chamadas com resumo IA.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "recent_summaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "a13dff32-284c-4ad8-9355-1bff484110ae", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "recent_summaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "308cdbaa-9203-4f67-a3f4-0913496d7b11", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "recent_summaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48dc6f93-fb5b-4090-a6c7-0e9ea2b397e2", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "recent_summaries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aacd4139-8a6e-4d69-b9bc-9a21ce75b94f", "name": "Buscar metas", "request": { "name": "Buscar metas", "description": { "content": "Metas configuradas.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "5ebb53f0-6446-4250-883e-2159d40a8682", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4419a3b4-7c1f-4257-bcd3-f8095331f99d", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "738e9a6c-29f1-474f-a838-19ade38a6f62", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "32390782-8f36-4f0d-9ff8-60bde375c85a", "name": "Atualizar metas", "request": { "name": "Atualizar metas", "description": { "content": "Atualiza alvo.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "87426119-d69d-4b43-bd76-7a25bf285ad1", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a0da7ff8-6fc5-47d0-8fef-1be43b1681e1", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0903630a-ea1a-467c-bc64-5913ae4c9065", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "voip_analytics", "targets" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "41a553ae-cc2c-44be-a59d-1215ac04a32b", "name": "Call Records", "description": { "content": "Historico de chamadas.", "type": "text/plain" }, "item": [ { "id": "649855bc-763c-4929-bea3-d1320526fce6", "name": "Listar chamadas", "request": { "name": "Listar chamadas", "description": { "content": "Historico: status, duracao, scoring, transcricao.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "29a556d9-ba87-4b0d-8f7c-8393ba76ddfc", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6c112af6-1308-417f-8227-0071ddebeaa2", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "ad3ea327-edb3-4b94-9625-029d6b20d01f", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d7c73cf-956b-4e1f-96e2-fefbec3a68df", "name": "Detalhe da chamada", "request": { "name": "Detalhe da chamada", "description": { "content": "Inclui transcricao + analise IA.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "61975a3f-8381-46ee-b1a8-f4208be67f04", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "554f5ce2-b3da-4400-9ccf-1b591bae2065", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0440bfb4-fb58-4dce-a1c7-3a30d396bff2", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b20723b-1e62-4c95-9568-b4688377aca4", "name": "Atualizar chamada", "request": { "name": "Atualizar chamada", "description": { "content": "Disposition + notas.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{\n \"disposition\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "606ef1fc-90f9-4084-a168-7b3df7702520", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"disposition\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8438ba6b-7d35-4124-8391-6886a2122716", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"disposition\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b268d178-8879-4061-842e-59a79b1c48b1", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "call_records", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"disposition\": \"string\",\n \"notes\": \"string\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ac777b10-4d89-43cb-8367-2b2830d1d082", "name": "Lead Scoring", "description": { "content": "Pontuacao de leads.", "type": "text/plain" }, "item": [ { "id": "ec5bac51-602e-4a5b-9ec2-3c043ca5ce54", "name": "Historico de scoring", "request": { "name": "Historico de scoring", "description": { "content": "Pontuacoes ao longo do tempo + razoes.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "lead_scores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "contact_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "fbe1afb6-eb22-4bb2-8702-179748f1046c", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "lead_scores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "contact_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "228049c3-0ce7-4924-ae02-5ea3009ea978", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "lead_scores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "contact_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "eab31fe1-0b21-440c-9da5-ae526d73f5ab", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "lead_scores" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "contact_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "2ef28d7f-8b83-412a-9eb8-84f2fa7c82af", "name": "Chatbot Flows", "description": { "content": "Flow Builder.", "type": "text/plain" }, "item": [ { "id": "922ef11e-bc28-459d-88a5-37c81d107ccb", "name": "Listar fluxos", "request": { "name": "Listar fluxos", "description": { "content": "Lista flows.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "3b0f9561-b06c-4f43-8c0a-05929945f60d", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5df6c961-cbd0-419f-8611-61339a751324", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c899038e-e650-43a1-827a-8dc1ff803be9", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3579a7d-359a-498b-8452-680feac70b15", "name": "Criar fluxo", "request": { "name": "Criar fluxo", "description": { "content": "Drag-and-drop.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"inbox_ids\": [\n 8857,\n 5636\n ],\n \"flow_data\": {},\n \"enabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "33f70076-0821-425e-a7f7-d5067dd386c2", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"inbox_ids\": [\n 4972,\n 9513\n ],\n \"flow_data\": {},\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "08a1500a-9443-4cf7-8859-c3d3e9810153", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"inbox_ids\": [\n 4972,\n 9513\n ],\n \"flow_data\": {},\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d740532d-7fe7-4521-9d57-849bdb0abd5f", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"inbox_ids\": [\n 4972,\n 9513\n ],\n \"flow_data\": {},\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5588dd61-a3e9-4c2d-9105-44f68f8e46f7", "name": "Detalhe do flow", "request": { "name": "Detalhe do flow", "description": { "content": "JSON completo.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "auth": null }, "response": [ { "id": "086cbc52-8c69-48ef-b03a-0b88b732f75f", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "56ca6b55-5c27-4ebd-b72d-408b8e1b84db", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c412a910-16ea-4519-a5c8-6a2515f4bad3", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6f3286e-0c9c-43b7-ba41-1245771158ca", "name": "Atualizar flow", "request": { "name": "Atualizar flow", "description": { "content": "Nodes/edges.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "auth": null, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1d86fdc5-5b87-4654-bc30-b5e7f4da96be", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5d428dcc-4b4b-4f01-93c5-83e9d430f46e", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "99d747ef-0b1d-466c-8bbf-82d187ba09ca", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36cae4e3-a139-45ec-8c98-c17c21892701", "name": "Excluir flow", "request": { "name": "Excluir flow", "description": { "content": "Remove.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "b77fc411-8269-483d-8a56-540e5e9c18ff", "name": "Sucesso", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6818019b-044c-4b82-85f5-946ee8038d5e", "name": "Nao autorizado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1612966d-6f14-4e5d-b2ff-6bbb0730ecb7", "name": "Nao encontrado", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "chatbot_flows", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "4630", "key": "id", "description": "(Required) " } ] }, "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c5996dc3-9304-4432-b2a8-54ad855f304c", "name": "Inbox API", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "5b16040c-7c0e-4c83-bfea-5fff56dda6e4", "name": "Inbox details", "request": { "name": "Inbox details", "description": { "content": "Get the details of an inbox", "type": "text/plain" }, "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e5a6d5ea-8da9-41eb-8ab4-c113e13176fb", "name": "Success", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"identifier\": \"string\",\n \"name\": \"string\",\n \"timezone\": \"string\",\n \"working_hours\": [\n {\n \"day_of_week\": 6211,\n \"open_all_day\": false,\n \"closed_all_day\": false,\n \"open_hour\": 8048,\n \"open_minutes\": 8270,\n \"close_hour\": 2376,\n \"close_minutes\": 5912\n },\n {\n \"day_of_week\": 9915,\n \"open_all_day\": false,\n \"closed_all_day\": true,\n \"open_hour\": 8782,\n \"open_minutes\": 9594,\n \"close_hour\": 3986,\n \"close_minutes\": 8558\n }\n ],\n \"working_hours_enabled\": true,\n \"csat_survey_enabled\": true,\n \"greeting_enabled\": true,\n \"identity_validation_enabled\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b95d23c4-6c57-4b88-9c21-091495b61841", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe8117b3-454a-4c10-943c-ba7b4a5feca0", "name": "The given inbox does not exist", "originalRequest": { "url": { "path": [ "public", "api", "v1", "inboxes", ":inbox_identifier" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "string", "key": "inbox_identifier", "description": "(Required) The identifier obtained from API inbox channel" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f87096f5-0bbb-491d-9b5d-7ec452eca708", "name": "Account", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "32d2eca1-5e64-485e-98be-c916fdbc1c27", "name": "Get account details", "request": { "name": "Get account details", "description": { "content": "Get the details of the current account", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "9124fd6a-96fb-4bd9-92e2-c08c535d1ddb", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 9413.428625646613,\n \"name\": \"string\",\n \"locale\": \"string\",\n \"domain\": \"string\",\n \"support_email\": \"string\",\n \"status\": \"string\",\n \"created_at\": \"1984-05-09T12:21:00.584Z\",\n \"cache_keys\": {},\n \"features\": {},\n \"settings\": {\n \"auto_resolve_after\": 1808.1653160372846,\n \"auto_resolve_message\": \"string\",\n \"auto_resolve_ignore_waiting\": true\n },\n \"custom_attributes\": {\n \"plan_name\": \"string\",\n \"subscribed_quantity\": 3033.3857472262803,\n \"subscription_status\": \"string\",\n \"subscription_ends_on\": \"1947-07-27\",\n \"industry\": \"string\",\n \"company_size\": \"string\",\n \"timezone\": \"string\",\n \"logo\": \"string\",\n \"onboarding_step\": \"string\",\n \"marked_for_deletion_at\": \"1981-09-23T12:18:57.281Z\",\n \"marked_for_deletion_reason\": \"string\"\n },\n \"subscribed_features\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f785c25f-a418-4834-bbf3-cbd7692966aa", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81f9fe8e-1dd8-4b95-8f82-4a0f3c1327d0", "name": "Account not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d96c89b1-7843-46c7-bf2d-734df8a97ca8", "name": "Update account", "request": { "name": "Update account", "description": { "content": "Update account details, settings, and custom attributes", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "key": "name", "value": "My Account", "description": "Name of the account" }, { "disabled": false, "key": "locale", "value": "en", "description": "The locale of the account" }, { "disabled": false, "key": "domain", "value": "example.com", "description": "The domain of the account" }, { "disabled": false, "key": "support_email", "value": "support@example.com", "description": "The support email of the account" }, { "disabled": false, "key": "auto_resolve_after", "value": "1440", "description": "Auto resolve conversations after specified minutes" }, { "disabled": false, "key": "auto_resolve_message", "value": "This conversation has been automatically resolved due to inactivity", "description": "Message to send when auto resolving" }, { "disabled": false, "key": "auto_resolve_ignore_waiting", "value": "false", "description": "Whether to ignore waiting conversations for auto resolve" }, { "disabled": false, "key": "industry", "value": "Technology", "description": "Industry type" }, { "disabled": false, "key": "company_size", "value": "50-100", "description": "Company size" }, { "disabled": false, "key": "timezone", "value": "UTC", "description": "Account timezone" } ] } }, "response": [ { "id": "fd57b5fb-28e8-4616-93b0-0cebe3bd6700", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "Name of the account", "type": "text/plain" }, "key": "name", "value": "My Account" }, { "disabled": false, "description": { "content": "The locale of the account", "type": "text/plain" }, "key": "locale", "value": "en" }, { "disabled": false, "description": { "content": "The domain of the account", "type": "text/plain" }, "key": "domain", "value": "example.com" }, { "disabled": false, "description": { "content": "The support email of the account", "type": "text/plain" }, "key": "support_email", "value": "support@example.com" }, { "disabled": false, "description": { "content": "Auto resolve conversations after specified minutes", "type": "text/plain" }, "key": "auto_resolve_after", "value": "1440" }, { "disabled": false, "description": { "content": "Message to send when auto resolving", "type": "text/plain" }, "key": "auto_resolve_message", "value": "This conversation has been automatically resolved due to inactivity" }, { "disabled": false, "description": { "content": "Whether to ignore waiting conversations for auto resolve", "type": "text/plain" }, "key": "auto_resolve_ignore_waiting", "value": "false" }, { "disabled": false, "description": { "content": "Industry type", "type": "text/plain" }, "key": "industry", "value": "Technology" }, { "disabled": false, "description": { "content": "Company size", "type": "text/plain" }, "key": "company_size", "value": "50-100" }, { "disabled": false, "description": { "content": "Account timezone", "type": "text/plain" }, "key": "timezone", "value": "UTC" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 138.24432742852278,\n \"name\": \"string\",\n \"locale\": \"string\",\n \"domain\": \"string\",\n \"support_email\": \"string\",\n \"status\": \"string\",\n \"created_at\": \"2025-05-28T04:47:00.708Z\",\n \"cache_keys\": {},\n \"features\": {},\n \"settings\": {\n \"auto_resolve_after\": 2926.166137715328,\n \"auto_resolve_message\": \"string\",\n \"auto_resolve_ignore_waiting\": true\n },\n \"custom_attributes\": {\n \"plan_name\": \"string\",\n \"subscribed_quantity\": 2680.9687251991677,\n \"subscription_status\": \"string\",\n \"subscription_ends_on\": \"2022-04-06\",\n \"industry\": \"string\",\n \"company_size\": \"string\",\n \"timezone\": \"string\",\n \"logo\": \"string\",\n \"onboarding_step\": \"string\",\n \"marked_for_deletion_at\": \"2024-08-11T11:21:40.833Z\",\n \"marked_for_deletion_reason\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f7bd87e-8d92-4790-bba6-a90b78ef8dd8", "name": "Unauthorized (requires administrator role)", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "Name of the account", "type": "text/plain" }, "key": "name", "value": "My Account" }, { "disabled": false, "description": { "content": "The locale of the account", "type": "text/plain" }, "key": "locale", "value": "en" }, { "disabled": false, "description": { "content": "The domain of the account", "type": "text/plain" }, "key": "domain", "value": "example.com" }, { "disabled": false, "description": { "content": "The support email of the account", "type": "text/plain" }, "key": "support_email", "value": "support@example.com" }, { "disabled": false, "description": { "content": "Auto resolve conversations after specified minutes", "type": "text/plain" }, "key": "auto_resolve_after", "value": "1440" }, { "disabled": false, "description": { "content": "Message to send when auto resolving", "type": "text/plain" }, "key": "auto_resolve_message", "value": "This conversation has been automatically resolved due to inactivity" }, { "disabled": false, "description": { "content": "Whether to ignore waiting conversations for auto resolve", "type": "text/plain" }, "key": "auto_resolve_ignore_waiting", "value": "false" }, { "disabled": false, "description": { "content": "Industry type", "type": "text/plain" }, "key": "industry", "value": "Technology" }, { "disabled": false, "description": { "content": "Company size", "type": "text/plain" }, "key": "company_size", "value": "50-100" }, { "disabled": false, "description": { "content": "Account timezone", "type": "text/plain" }, "key": "timezone", "value": "UTC" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7d3f471-f29c-446c-bb37-bb0bf93f69b8", "name": "Account not found", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "Name of the account", "type": "text/plain" }, "key": "name", "value": "My Account" }, { "disabled": false, "description": { "content": "The locale of the account", "type": "text/plain" }, "key": "locale", "value": "en" }, { "disabled": false, "description": { "content": "The domain of the account", "type": "text/plain" }, "key": "domain", "value": "example.com" }, { "disabled": false, "description": { "content": "The support email of the account", "type": "text/plain" }, "key": "support_email", "value": "support@example.com" }, { "disabled": false, "description": { "content": "Auto resolve conversations after specified minutes", "type": "text/plain" }, "key": "auto_resolve_after", "value": "1440" }, { "disabled": false, "description": { "content": "Message to send when auto resolving", "type": "text/plain" }, "key": "auto_resolve_message", "value": "This conversation has been automatically resolved due to inactivity" }, { "disabled": false, "description": { "content": "Whether to ignore waiting conversations for auto resolve", "type": "text/plain" }, "key": "auto_resolve_ignore_waiting", "value": "false" }, { "disabled": false, "description": { "content": "Industry type", "type": "text/plain" }, "key": "industry", "value": "Technology" }, { "disabled": false, "description": { "content": "Company size", "type": "text/plain" }, "key": "company_size", "value": "50-100" }, { "disabled": false, "description": { "content": "Account timezone", "type": "text/plain" }, "key": "timezone", "value": "UTC" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a09feff-d3d2-4b2e-9ace-c2b31a38de40", "name": "Validation error", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "Name of the account", "type": "text/plain" }, "key": "name", "value": "My Account" }, { "disabled": false, "description": { "content": "The locale of the account", "type": "text/plain" }, "key": "locale", "value": "en" }, { "disabled": false, "description": { "content": "The domain of the account", "type": "text/plain" }, "key": "domain", "value": "example.com" }, { "disabled": false, "description": { "content": "The support email of the account", "type": "text/plain" }, "key": "support_email", "value": "support@example.com" }, { "disabled": false, "description": { "content": "Auto resolve conversations after specified minutes", "type": "text/plain" }, "key": "auto_resolve_after", "value": "1440" }, { "disabled": false, "description": { "content": "Message to send when auto resolving", "type": "text/plain" }, "key": "auto_resolve_message", "value": "This conversation has been automatically resolved due to inactivity" }, { "disabled": false, "description": { "content": "Whether to ignore waiting conversations for auto resolve", "type": "text/plain" }, "key": "auto_resolve_ignore_waiting", "value": "false" }, { "disabled": false, "description": { "content": "Industry type", "type": "text/plain" }, "key": "industry", "value": "Technology" }, { "disabled": false, "description": { "content": "Company size", "type": "text/plain" }, "key": "company_size", "value": "50-100" }, { "disabled": false, "description": { "content": "Account timezone", "type": "text/plain" }, "key": "timezone", "value": "UTC" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f7b88a15-59f2-481f-8c45-23c0322f7f7f", "name": "Audit Logs", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "04dbd103-8d62-41a6-a8ba-8cce96ed5437", "name": "List Audit Logs in Account", "request": { "name": "List Audit Logs in Account", "description": { "content": "Get Details of Audit Log entries for an Account. This endpoint is only available in Enterprise editions and requires the audit_logs feature to be enabled.", "type": "text/plain" }, "url": { "path": [ "api", "v1", "accounts", ":account_id", "audit_logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "Page number for pagination" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "api_access_token" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a24bedb4-fe36-4072-aebf-36e26bd24ce3", "name": "Success", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "audit_logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"per_page\": 15,\n \"total_entries\": 150,\n \"current_page\": 1,\n \"audit_logs\": [\n {\n \"id\": 7454,\n \"auditable_id\": 1494,\n \"auditable_type\": \"string\",\n \"auditable\": {},\n \"associated_id\": 4614,\n \"associated_type\": \"string\",\n \"user_id\": 9116,\n \"user_type\": \"string\",\n \"username\": \"string\",\n \"action\": \"destroy\",\n \"audited_changes\": {},\n \"version\": 7007,\n \"comment\": \"string\",\n \"request_uuid\": \"string\",\n \"created_at\": 4175,\n \"remote_address\": \"string\"\n },\n {\n \"id\": 9041,\n \"auditable_id\": 3,\n \"auditable_type\": \"string\",\n \"auditable\": {},\n \"associated_id\": 7279,\n \"associated_type\": \"string\",\n \"user_id\": 818,\n \"user_type\": \"string\",\n \"username\": \"string\",\n \"action\": \"destroy\",\n \"audited_changes\": {},\n \"version\": 2843,\n \"comment\": \"string\",\n \"request_uuid\": \"string\",\n \"created_at\": 1614,\n \"remote_address\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fa3ecba-9762-42ee-bf0b-1501a638d8dc", "name": "Access denied", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "audit_logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40895b99-73b2-49ac-9984-a261838cd6b1", "name": "Feature not enabled or not available in current plan", "originalRequest": { "url": { "path": [ "api", "v1", "accounts", ":account_id", "audit_logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" } ], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "api_access_token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"description\": \"string\",\n \"errors\": [\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n },\n {\n \"field\": \"string\",\n \"message\": \"string\",\n \"code\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "33c0ec57-01c4-4a04-a51c-07f7a114f77f", "name": "Conversation", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "6df58064-cd56-4aec-a02e-c8d86b8a7ac4", "name": "Get messages from a conversation", "request": { "name": "Get messages from a conversation", "description": { "content": "Returns all messages from a specific conversation", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "conversation_id", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "9302e490-cb4f-4d00-94a0-da77df7e649f", "name": "Success", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "4630", "key": "account_id", "description": "(Required) The numeric ID of the account" }, { "disabled": false, "type": "any", "value": "3074.5223851301052", "key": "conversation_id", "description": "(Required) ID of the conversation" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"meta\": {\n \"labels\": [\n \"string\",\n \"string\"\n ],\n \"additional_attributes\": {\n \"browser\": {\n \"device_name\": \"string\",\n \"browser_name\": \"string\",\n \"platform_name\": \"string\",\n \"browser_version\": \"string\",\n \"platform_version\": \"string\"\n },\n \"referer\": \"string\",\n \"initiated_at\": {\n \"timestamp\": \"string\"\n },\n \"browser_language\": \"string\",\n \"conversation_language\": \"string\"\n },\n \"contact\": {\n \"additional_attributes\": {\n \"city\": {\n \"value\": \"\"\n },\n \"country\": {\n \"value\": \"\"\n },\n \"country_code\": {\n \"value\": \"\"\n },\n \"created_at_ip\": {\n \"value\": \"\"\n }\n },\n \"custom_attributes\": {},\n \"email\": \"string\",\n \"id\": 4552,\n \"identifier\": \"string\",\n \"name\": \"string\",\n \"phone_number\": \"string\",\n \"thumbnail\": \"string\",\n \"blocked\": true,\n \"type\": \"contact\"\n },\n \"assignee\": {\n \"id\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"availability_status\": {\n \"value\": \"\"\n },\n \"auto_offline\": {\n \"value\": \"\"\n },\n \"confirmed\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"available_name\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"role\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"custom_role_id\": {\n \"value\": \"\"\n }\n },\n \"agent_last_seen_at\": \"string\",\n \"assignee_last_seen_at\": \"string\"\n },\n \"payload\": [\n {\n \"id\": 8180.968431246875,\n \"content\": \"string\",\n \"inbox_id\": 9286.21510265865,\n \"conversation_id\": 1830.1419205501356,\n \"message_type\": 3,\n \"content_type\": \"voice_call\",\n \"status\": \"read\",\n \"content_attributes\": {\n \"in_reply_to\": \"string\"\n },\n \"echo_id\": \"string\",\n \"created_at\": 7341,\n \"private\": true,\n \"source_id\": \"string\",\n \"sender\": {\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n }\n },\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n }\n }\n ]\n },\n {\n \"id\": 7095.547456625683,\n \"content\": \"string\",\n \"inbox_id\": 2114.550905200263,\n \"conversation_id\": 8574.880040944048,\n \"message_type\": 2,\n \"content_type\": \"input_text\",\n \"status\": \"sent\",\n \"content_attributes\": {\n \"in_reply_to\": \"string\"\n },\n \"echo_id\": \"string\",\n \"created_at\": 545,\n \"private\": true,\n \"source_id\": \"string\",\n \"sender\": {\n \"additional_attributes\": {\n \"value\": \"\"\n },\n \"custom_attributes\": {\n \"value\": \"\"\n },\n \"email\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n },\n \"identifier\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"phone_number\": {\n \"value\": \"\"\n },\n \"thumbnail\": {\n \"value\": \"\"\n },\n \"blocked\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n }\n },\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"message_id\": {\n \"value\": \"\"\n },\n \"file_type\": {\n \"value\": \"\"\n },\n \"account_id\": {\n \"value\": \"\"\n },\n \"data_url\": {\n \"value\": \"\"\n },\n \"thumb_url\": {\n \"value\": \"\"\n },\n \"file_size\": {\n \"value\": \"\"\n }\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c9639217-958a-4c1a-9195-444fdd8945af", "name": "Agentes (Kanban)", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f741f9a8-b11a-4800-a550-da139c394216", "name": "Atribuir agente", "request": { "name": "Atribuir agente", "description": { "content": "Atribui um agente ao kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "28ddb272-e98a-41cd-a15c-263ecc8f80e2", "name": "Agente atribuído", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45357bde-f65a-425f-ad2f-4cdc27bcaae3", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "060ae345-f0e7-428b-ab9b-bd8b8d7dab20", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49da9a1-76d7-4b99-8d9c-2ba8d13963e7", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assign_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ca18536-4060-49ec-b397-26e84d0d42d8", "name": "Remover agente", "request": { "name": "Remover agente", "description": { "content": "Remove um agente do kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d6a47125-544e-4742-9554-49b8472843e8", "name": "Agente removido", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"funnel_id\": 1,\n \"funnel_stage\": \"lead\",\n \"item_details\": {\n \"title\": \"Novo Lead\",\n \"description\": \"Descrição do lead\",\n \"status\": \"active\",\n \"priority\": \"high\",\n \"value\": 1000,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"custom_attributes\": [\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n },\n {\n \"name\": \"string\",\n \"value\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"offers\": [\n {\n \"value\": 5345.397391549128,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n },\n {\n \"value\": 5544.882213836811,\n \"currency\": {\n \"symbol\": \"string\",\n \"code\": \"string\",\n \"locale\": \"string\"\n },\n \"description\": \"string\"\n }\n ],\n \"deadline_at\": \"1969-10-08T05:20:12.812Z\",\n \"scheduling_type\": \"string\",\n \"scheduled_at\": \"1966-02-22T12:01:38.825Z\",\n \"activities\": [\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 6147,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1958-12-09T01:18:32.446Z\"\n },\n {\n \"id\": \"string\",\n \"type\": \"string\",\n \"user\": {\n \"id\": 9438,\n \"name\": \"string\",\n \"avatar_url\": \"string\"\n },\n \"details\": {\n \"user\": {\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"avatar_url\": {\n \"value\": \"\"\n }\n },\n \"new_stage\": \"string\",\n \"old_stage\": \"string\"\n },\n \"created_at\": \"1991-03-03T01:05:09.399Z\"\n }\n ],\n \"conversation_id\": 8828,\n \"notes\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1966-07-24T04:08:41.019Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 7355,\n \"linked_conversation_id\": 1004,\n \"linked_contact_id\": 5593,\n \"author\": \"string\",\n \"author_id\": 1525,\n \"author_avatar\": \"string\"\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"created_at\": \"1999-03-17T14:17:15.830Z\",\n \"attachments\": [\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"filename\": {\n \"value\": \"\"\n },\n \"byte_size\": {\n \"value\": \"\"\n },\n \"content_type\": {\n \"value\": \"\"\n },\n \"created_at\": {\n \"value\": \"\"\n }\n }\n ],\n \"linked_item_id\": 4663,\n \"linked_conversation_id\": 6613,\n \"linked_contact_id\": 2110,\n \"author\": \"string\",\n \"author_id\": 8260,\n \"author_avatar\": \"string\"\n }\n ]\n },\n \"position\": 1,\n \"conversation_display_id\": 123,\n \"timer_started_at\": \"2024-01-15T10:00:00Z\",\n \"timer_duration\": 3600,\n \"stage_entered_at\": \"2024-01-15T10:00:00Z\",\n \"checklist\": [\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1951-06-21T20:03:33.297Z\",\n \"position\": 8196,\n \"agent_id\": 5962\n },\n {\n \"id\": \"string\",\n \"text\": \"string\",\n \"completed\": true,\n \"created_at\": \"1960-04-04T03:15:38.636Z\",\n \"position\": 9260,\n \"agent_id\": 8444\n }\n ],\n \"assigned_agents\": [\n 8010,\n 5961\n ],\n \"custom_attributes\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"account_id\": 1,\n \"created_at\": \"2024-01-15T10:00:00Z\",\n \"updated_at\": \"2024-01-15T10:00:00Z\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb8c01d6-ab02-4ac3-ad15-b7185876024b", "name": "Requisição inválida", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b4b8949-3aef-4268-99e3-f1b91fb050d2", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8428920-d2e8-43ba-9630-7ad3ad571a34", "name": "Entidade não processável", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "remove_agent" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"agent_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ce9979b-9cce-41a8-98c2-ff6ca2f299f6", "name": "Listar agentes atribuídos", "request": { "name": "Listar agentes atribuídos", "description": { "content": "Retorna os agentes atribuídos ao kanban item", "type": "text/plain" }, "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assigned_agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b361448f-2779-4e39-ac68-361cfded9111", "name": "Agentes atribuídos", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assigned_agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assigned_agents\": [\n {\n \"id\": 1,\n \"name\": \"João Silva\",\n \"email\": \"joao@example.com\",\n \"avatar_url\": \"https://example.com/avatar.jpg\",\n \"availability_status\": \"online\"\n }\n ],\n \"primary_agent\": {\n \"id\": 1,\n \"name\": \"João Silva\",\n \"email\": \"joao@example.com\",\n \"avatar_url\": \"https://example.com/avatar.jpg\",\n \"availability_status\": \"online\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9db60f2-d2a2-4be4-940f-b2d98df3d024", "name": "Recurso não encontrado", "originalRequest": { "url": { "path": [ "accounts", ":account_id", "kanban_items", ":id", "assigned_agents" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "1", "key": "account_id", "description": "(Required) ID da conta" }, { "disabled": false, "type": "any", "value": "1", "key": "id", "description": "(Required) ID do item" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"Erro ao processar requisição\",\n \"status\": \"bad_request\",\n \"details\": {\n \"key_0\": 5592,\n \"key_1\": true,\n \"key_2\": 997\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://app.siteup.com.br", "key": "baseUrl" } ], "info": { "_postman_id": "bf6f56eb-16df-445e-a064-4d970232bffb", "name": "SiteUp API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "API completa da plataforma SiteUp.\n\n## Recursos\n\n- **Atendimento**: contatos, conversas, mensagens, caixas multi-canal\n- **Kanban**: funnels, stages, items, atribuição de agentes\n- **Automação**: regras, webhooks, integrações\n- **Analytics**: relatórios, métricas\n- **Equipe**: agentes, times, perfis\n\n## Autenticação\n\nHeader `api_access_token: ` na maioria dos endpoints. Endpoints `/public/api/v1/*` usam identificadores públicos.\n\n\nContact Support:\n Name: Time SiteUp\n Email: contato@siteup.com.br", "type": "text/plain" } } }