{ "info": { "_postman_id": "3401f130-b6de-485e-8fe6-fcd39004c6be", "name": "Interleads Chat API", "description": "Coleção oficial da API da Interleads Chat. Defina as variáveis `baseUrl`, `token` (seu token de acesso) e `account_id` antes de usar.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://appchat01.interleads.chat" }, { "key": "token", "value": "" }, { "key": "account_id", "value": "" } ], "item": [ { "name": "Contatos", "item": [ { "name": "Create contact inbox", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/contact_inboxes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contact_inboxes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Create a contact inbox record for an inbox", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"source_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Contactable Inboxes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/contactable_inboxes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "contactable_inboxes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Get List of contactable Inboxes" }, "response": [] }, { "name": "List Labels", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Lists all the labels of a contact" }, "response": [] }, { "name": "Add Labels", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Merge Contacts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/actions/contact_merge", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "actions", "contact_merge" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "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", "body": { "mode": "raw", "raw": "{\n \"base_contact_id\": 1,\n \"mergee_contact_id\": 2\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Contacts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number" }, "response": [] }, { "name": "Create Contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Create a new Contact", "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\": \"https://example.com/resource\",\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 \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get active", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", "active" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns active." }, "response": [] }, { "name": "Export", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/export", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", "export" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Exports data and returns the generated file.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Export\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Contact Filter", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/filter?page=1.0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", "filter" ], "query": [ { "key": "page", "value": "1.0", "disabled": true } ], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Filter contacts with custom filter options and pagination", "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"name\",\n \"filter_operator\": \"equal_to\",\n \"values\": [\n \"en\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"country_code\",\n \"filter_operator\": \"equal_to\",\n \"values\": [\n \"us\"\n ],\n \"query_operator\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Import", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", "import" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Imports data from the provided payload.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Import\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search Contacts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/search?q=sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", "search" ], "query": [ { "key": "q", "value": "sample", "disabled": true } ], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "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" }, "response": [] }, { "name": "List contact attachments", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "attachments" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" } ] }, "description": "Returns contact attachments." }, "response": [] }, { "name": "Get notes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" } ] }, "description": "Returns notes." }, "response": [] }, { "name": "Create notes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" } ] }, "description": "Creates notes.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Note\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get new notes form", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes/new", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes", "new" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" } ] }, "description": "Returns new notes form." }, "response": [] }, { "name": "Delete notes", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes notes." }, "response": [] }, { "name": "Get notes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns notes." }, "response": [] }, { "name": "Update notes", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates notes.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Note\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace notes", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:contact_id/notes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":contact_id", "notes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "contact_id", "value": "{{contact_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates notes.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Note\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Contact", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Delete a contact belonging to the account using ID" }, "response": [] }, { "name": "Show Contact", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Get a contact belonging to the account using ID" }, "response": [] }, { "name": "Patch Contact", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Patch a contact belonging to the account using ID", "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"https://example.com/resource\",\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 \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Contact", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Update a contact belonging to the account using ID", "body": { "mode": "raw", "raw": "{\n \"name\": \"Alice\",\n \"email\": \"alice@acme.inc\",\n \"blocked\": false,\n \"phone_number\": \"+123456789\",\n \"avatar\": \"https://example.com/resource\",\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 \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete avatar", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/avatar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "avatar" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes avatar." }, "response": [] }, { "name": "Contact Conversations", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "conversations" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Get conversations associated with that contact" }, "response": [] }, { "name": "Create destroy custom attributes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/destroy_custom_attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "destroy_custom_attributes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates destroy custom attributes.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Destroy Custom Attribute\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create contact call record", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/contacts/:id/call", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "contacts", ":id", "call" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates contact call record.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Call\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Conversas", "item": [ { "name": "Assign Conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/assignments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "assignments" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Assign a conversation to an agent or a team", "body": { "mode": "raw", "raw": "{\n \"assignee_id\": 1,\n \"team_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Conversations List", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations?assignee_type=sample&inbox_id=1&labels=[]&page=1&q=sample&status=sample&team_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "query": [ { "key": "assignee_type", "value": "sample", "disabled": true }, { "key": "inbox_id", "value": "1", "disabled": true }, { "key": "labels", "value": "[]", "disabled": true }, { "key": "page", "value": "1", "disabled": true }, { "key": "q", "value": "sample", "disabled": true }, { "key": "status", "value": "sample", "disabled": true }, { "key": "team_id", "value": "1", "disabled": true } ], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "List all the conversations with pagination" }, "response": [] }, { "name": "Create New Conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creating a conversation in chatwoot requires a source id. \n\n Learn more about source_id: https://www.chatwoot.com/hc/user-guide/articles/1677839703-how-to-create-an-api-channel-inbox#send-messages-to-the-api-channel", "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\": \"Chatwoot\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Conversations Filter", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/filter?page=1.0", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", "filter" ], "query": [ { "key": "page", "value": "1.0", "disabled": true } ], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Filter conversations with custom filter options and pagination", "body": { "mode": "raw", "raw": "{\n \"payload\": [\n {\n \"attribute_key\": \"browser_language\",\n \"filter_operator\": \"not_equal_to\",\n \"values\": [\n \"en\"\n ],\n \"query_operator\": \"AND\"\n },\n {\n \"attribute_key\": \"status\",\n \"filter_operator\": \"equal_to\",\n \"values\": [\n \"pending\"\n ],\n \"query_operator\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get Conversation Counts", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/meta?inbox_id=1&labels=[]&q=sample&status=sample&team_id=1", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", "meta" ], "query": [ { "key": "inbox_id", "value": "1", "disabled": true }, { "key": "labels", "value": "[]", "disabled": true }, { "key": "q", "value": "sample", "disabled": true }, { "key": "status", "value": "sample", "disabled": true }, { "key": "team_id", "value": "1", "disabled": true } ], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Get open, unassigned and all Conversation counts" }, "response": [] }, { "name": "Search", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", "search" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns resource." }, "response": [] }, { "name": "Delete Conversation", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Deletes Conversation." }, "response": [] }, { "name": "Conversation Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Get all details regarding a conversation with all messages in the conversation" }, "response": [] }, { "name": "Update Conversation", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Update Conversation Attributes", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Conversation", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Update Conversation Attributes", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\",\n \"sla_policy_id\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Custom Attributes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/custom_attributes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "custom_attributes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates the custom attributes of a conversation", "body": { "mode": "raw", "raw": "{\n \"custom_attributes\": {\n \"order_id\": \"12345\",\n \"previous_conversation\": \"67890\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create direct uploads", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/direct_uploads", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "direct_uploads" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates direct uploads.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Direct Upload\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete draft messages", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/draft_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "draft_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Deletes draft messages." }, "response": [] }, { "name": "Get draft messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/draft_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "draft_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns draft messages." }, "response": [] }, { "name": "Update draft messages", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/draft_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "draft_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates draft messages.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Draft Message\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace draft messages", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/draft_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "draft_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates draft messages.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Draft Message\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get group members", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns group members." }, "response": [] }, { "name": "Add", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", "add" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates resource.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Add\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create fetch names", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/fetch_names", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", "fetch_names" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates fetch names.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Fetch Name\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", "search" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns resource." }, "response": [] }, { "name": "Sync", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", "sync" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Runs synchronization and returns the current status.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Sync\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Sync async", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/sync_async", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", "sync_async" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Starts asynchronous synchronization and returns the job status.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Sync Async\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete remove", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/:id/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", ":id", "remove" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes remove." }, "response": [] }, { "name": "Update role", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_members/:id/update_role", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_members", ":id", "update_role" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates role.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Update Role\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get group settings", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns group settings." }, "response": [] }, { "name": "Update description", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings/description", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings", "description" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates description.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Description\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get invite code", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings/invite_code", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings", "invite_code" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns invite code." }, "response": [] }, { "name": "Delete picture", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings/picture", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings", "picture" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Deletes picture." }, "response": [] }, { "name": "Replace picture", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings/picture", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings", "picture" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates picture.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Picture\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create revoke invite code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings/revoke_invite_code", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings", "revoke_invite_code" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates revoke invite code.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Revoke Invite Code\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update subject", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/group_settings/subject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "group_settings", "subject" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates subject.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Subject\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Labels", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Lists all the labels of a conversation" }, "response": [] }, { "name": "Add Labels", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.", "body": { "mode": "raw", "raw": "{\n \"labels\": [\n \"support\",\n \"billing\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get message context", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/message_context/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "message_context", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns message context." }, "response": [] }, { "name": "Get message search", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/message_search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "message_search" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns message search." }, "response": [] }, { "name": "Delete participants", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "participants" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Deletes participants." }, "response": [] }, { "name": "Get participants", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "participants" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns participants." }, "response": [] }, { "name": "Update participants", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "participants" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates participants.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Participant\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create participants", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "participants" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates participants.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Participant\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace participants", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "participants" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Updates participants.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Participant\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Conversation Reporting Events", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/reporting_events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "reporting_events" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "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." }, "response": [] }, { "name": "Toggle Priority", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/toggle_priority", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_priority" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Toggles the priority of conversation", "body": { "mode": "raw", "raw": "{\n \"priority\": \"high\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Toggle Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/toggle_status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "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.", "body": { "mode": "raw", "raw": "{\n \"status\": \"open\",\n \"snoozed_until\": 1757506877\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Toggle Typing Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/toggle_typing_status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "toggle_typing_status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Toggles the typing status for a conversation.", "body": { "mode": "raw", "raw": "{\n \"typing_status\": \"on\",\n \"is_private\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create voice recordings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/voice_recordings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "voice_recordings" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates voice recordings.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Voice Recording\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create accept", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/whatsapp_calls/accept", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "whatsapp_calls", "accept" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates accept.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Accept\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create reject", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/whatsapp_calls/reject", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "whatsapp_calls", "reject" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates reject.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Reject\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create sdp answer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/whatsapp_calls/sdp_answer", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "whatsapp_calls", "sdp_answer" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates sdp answer.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Sdp Answer\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get status", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/whatsapp_calls/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "whatsapp_calls", "status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Returns status." }, "response": [] }, { "name": "Create terminate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/whatsapp_calls/terminate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "whatsapp_calls", "terminate" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates terminate.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Terminate\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create upload recording", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/whatsapp_calls/upload_recording", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "whatsapp_calls", "upload_recording" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates upload recording.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Upload Recording\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get attachments", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "attachments" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns attachments." }, "response": [] }, { "name": "Get inbox assistant", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/inbox_assistant", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "inbox_assistant" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns inbox assistant." }, "response": [] }, { "name": "Create mute", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/mute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "mute" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates mute.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Mute\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create pin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/pin", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "pin" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates pin.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Pin\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create transcript", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/transcript", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "transcript" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates transcript.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Transcript\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create unmute", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/unmute", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "unmute" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates unmute.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Unmute\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create unpin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/unpin", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "unpin" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates unpin.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Unpin\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create unread", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/unread", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "unread" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates unread.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Unread\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update last seen", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:id/update_last_seen", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":id", "update_last_seen" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates last seen.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Update Last Seen\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "List all messages of a conversation" }, "response": [] }, { "name": "Create New Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "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", "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 \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\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 }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create forward", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:id/forward", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":id", "forward" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates forward.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Forward\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create retry", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:id/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":id", "retry" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates retry.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Retry\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create translate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:id/translate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":id", "translate" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates translate.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Translate\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a message", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:message_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "message_id", "value": "{{message_id}}" } ] }, "description": "Delete a message and it's attachments from the conversation." }, "response": [] }, { "name": "Patch message", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:message_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "message_id", "value": "{{message_id}}" } ] }, "description": "Updates message.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Message\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update message", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:message_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "message_id", "value": "{{message_id}}" } ] }, "description": "Updates message.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Message\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "React to a message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/messages/:message_id/reactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "messages", ":message_id", "reactions" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "message_id", "value": "{{message_id}}" } ] }, "description": "Adds, replaces, or removes the authenticated actor's reaction on a WhatsApp message.\n\nSend a single emoji to add or replace the reaction. Send an empty string to remove an existing reaction.\n", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"👍\",\n \"echo_id\": \"reaction-echo-123\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Mensagens agendadas", "item": [ { "name": "Cancel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id", "cancel" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Cancels the scheduled operation.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Cancel\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Conversation Scheduled Messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Lists all scheduled messages associated with a conversation's contact.\nIncludes messages from all conversations with the same contact.\n" }, "response": [] }, { "name": "Create Scheduled Message in Conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Creates a new scheduled message within an existing conversation", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Hello, this is a scheduled message from the conversation\",\n \"scheduled_at\": \"2026-02-06T15:00:00Z\",\n \"inbox_id\": 5,\n \"title\": \"Automatic follow-up\",\n \"attachments\": [\n \"Sample text\"\n ],\n \"template_params\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"recurrence_type\": \"none\",\n \"recurrence_interval\": 1,\n \"recurrence_days\": [\n 1\n ],\n \"recurrence_end_type\": \"never\",\n \"recurrence_end_date\": \"2026-05-20\",\n \"recurrence_max_occurrences\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Count Conversation Scheduled Messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages/count?status=sample", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", "count" ], "query": [ { "key": "status", "value": "sample", "disabled": true } ], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" } ] }, "description": "Counts the scheduled messages for a conversation's contact.\nCan be filtered by status using the `status` query parameter.\n" }, "response": [] }, { "name": "Delete Conversation Scheduled Message", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes a scheduled message from a conversation" }, "response": [] }, { "name": "Get Conversation Scheduled Message", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Gets the details of a specific scheduled message in a conversation" }, "response": [] }, { "name": "Update Conversation Scheduled Message", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a scheduled message in a conversation. Only pending messages can be updated.", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Hello, this is a scheduled message from the conversation\",\n \"scheduled_at\": \"2026-02-06T15:00:00Z\",\n \"inbox_id\": 5,\n \"title\": \"Automatic follow-up\",\n \"attachments\": [\n \"Sample text\"\n ],\n \"template_params\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"recurrence_type\": \"none\",\n \"recurrence_interval\": 1,\n \"recurrence_days\": [\n 1\n ],\n \"recurrence_end_type\": \"never\",\n \"recurrence_end_date\": \"2026-05-20\",\n \"recurrence_max_occurrences\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Conversation Scheduled Message", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/conversations/:conversation_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "conversations", ":conversation_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "conversation_id", "value": "{{conversation_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a scheduled message in a conversation. Only pending messages can be updated.", "body": { "mode": "raw", "raw": "{\n \"scheduled_message\": {\n \"content\": \"Hello, this is a scheduled message from the conversation\",\n \"scheduled_at\": \"2026-02-06T15:00:00Z\",\n \"inbox_id\": 5,\n \"title\": \"Automatic follow-up\",\n \"attachments\": [\n \"Sample text\"\n ],\n \"template_params\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"recurrence_type\": \"none\",\n \"recurrence_interval\": 1,\n \"recurrence_days\": [\n 1\n ],\n \"recurrence_end_type\": \"never\",\n \"recurrence_end_date\": \"2026-05-20\",\n \"recurrence_max_occurrences\": 1\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List All Scheduled Messages", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Lists all scheduled messages for the account, ordered by scheduled date descending" }, "response": [] }, { "name": "Create Scheduled Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates a new scheduled message at the account level.\n\n## Features\n- Schedule messages for future delivery\n- Attach up to 15 files\n- Use WhatsApp templates\n- Set up recurring messages (daily, weekly, monthly, yearly)\n\n## Recurrence Options\nMessages can be set to recur automatically:\n- **Daily**: Send every N days\n- **Weekly**: Send on specific days of the week\n- **Monthly**: Send every N months\n- **Yearly**: Send every N years\n\nYou can limit recurrence by:\n- Setting an end date\n- Limiting the number of occurrences\n- Setting it to never end\n", "body": { "mode": "raw", "raw": "\"string\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete Scheduled Message", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes a scheduled message. Can be deleted in any status.\n\n- Deleting a `pending` message cancels its sending\n- Deleting a recurring parent message stops all future occurrences\n" }, "response": [] }, { "name": "Get Scheduled Message Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Gets the details of a specific scheduled message including its status, content, recurrence settings, and attachments.\n\n## Use Cases\n- Check if a message was sent successfully\n- View scheduled message configuration\n- Monitor recurring message settings\n- Verify attachment details\n" }, "response": [] }, { "name": "Update Scheduled Message", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates an existing scheduled message. Only messages with `pending` status can be updated.\n\nThe `status` field cannot be modified manually - it's updated automatically when the message is sent or fails.\n", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello {{customer_name}}, your order #{{order_id}} will arrive tomorrow\",\n \"scheduled_at\": \"2026-02-06T15:00:00Z\",\n \"inbox_id\": 5,\n \"title\": \"Customer follow-up\",\n \"contact_id\": 456,\n \"conversation_id\": 123,\n \"attachments\": [\n \"Sample text\"\n ],\n \"template_params\": {\n \"name\": \"appointment_reminder\",\n \"category\": \"UTILITY\",\n \"language\": \"en\",\n \"namespace\": \"your_namespace\",\n \"processed_params\": {\n \"header\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"body\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"buttons\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n },\n \"recurrence_type\": \"daily\",\n \"recurrence_interval\": 1,\n \"recurrence_days\": [\n 1,\n 3,\n 5\n ],\n \"recurrence_end_type\": \"never\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Scheduled Message", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates an existing scheduled message. Only messages with `pending` status can be updated.\n\nThe `status` field cannot be modified manually - it's updated automatically when the message is sent or fails.\n", "body": { "mode": "raw", "raw": "{\n \"content\": \"Hello {{customer_name}}, your order #{{order_id}} will arrive tomorrow\",\n \"scheduled_at\": \"2026-02-06T15:00:00Z\",\n \"inbox_id\": 5,\n \"title\": \"Customer follow-up\",\n \"contact_id\": 456,\n \"conversation_id\": 123,\n \"attachments\": [\n \"Sample text\"\n ],\n \"template_params\": {\n \"name\": \"appointment_reminder\",\n \"category\": \"UTILITY\",\n \"language\": \"en\",\n \"namespace\": \"your_namespace\",\n \"processed_params\": {\n \"header\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"body\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"buttons\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n },\n \"recurrence_type\": \"daily\",\n \"recurrence_interval\": 1,\n \"recurrence_days\": [\n 1,\n 3,\n 5\n ],\n \"recurrence_end_type\": \"never\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Cancel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/scheduled_messages/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "scheduled_messages", ":id", "cancel" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Cancels the scheduled operation.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Cancel\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Inboxes", "item": [ { "name": "Delete conference", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/conference", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "conference" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Deletes conference." }, "response": [] }, { "name": "Create conference", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/conference", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "conference" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Creates conference.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Conference\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get token", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/conference/token", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "conference", "token" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Returns token." }, "response": [] }, { "name": "Remove an Agent from Inbox", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inbox_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Remove an Agent from Inbox", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Agents in Inbox", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inbox_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "All agents except the one passed in params will be removed", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add a New Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inbox_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inbox_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Add a new Agent to Inbox", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": 1,\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Agents in Inbox", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inbox_members/:inbox_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inbox_members", ":inbox_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Get Details of Agents in an Inbox" }, "response": [] }, { "name": "List all inboxes", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "List all inboxes available in the current account" }, "response": [] }, { "name": "Create an inbox", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Create an inbox in the account", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"https://example.com/resource\",\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}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create migrate", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/migrate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", "migrate" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates migrate.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Migrate\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get migrate status", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/migrate_status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", "migrate_status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns migrate status." }, "response": [] }, { "name": "Delete Inbox", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Delete an inbox in the account" }, "response": [] }, { "name": "Get an inbox", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Get an inbox in the account" }, "response": [] }, { "name": "Update Inbox", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Update an existing inbox", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"https://example.com/resource\",\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}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace Inbox", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Replace an existing inbox", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support\",\n \"avatar\": \"https://example.com/resource\",\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}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Show Inbox Agent Bot", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/agent_bot", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "agent_bot" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "See if an agent bot is associated to the Inbox" }, "response": [] }, { "name": "Get assignable agents", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/assignable_agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "assignable_agents" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns assignable agents." }, "response": [] }, { "name": "Get available whatsapp providers", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/available_whatsapp_providers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "available_whatsapp_providers" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns available whatsapp providers." }, "response": [] }, { "name": "Delete avatar", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/avatar", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "avatar" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes avatar." }, "response": [] }, { "name": "Get calling settings", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/calling_settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "calling_settings" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns calling settings." }, "response": [] }, { "name": "Get campaigns", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/campaigns", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "campaigns" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns campaigns." }, "response": [] }, { "name": "Create change whatsapp provider", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/change_whatsapp_provider", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "change_whatsapp_provider" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates change whatsapp provider.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Change Whatsapp Provider\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get health", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/health", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "health" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns health." }, "response": [] }, { "name": "Create initiate whatsapp call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/initiate_whatsapp_call", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "initiate_whatsapp_call" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates initiate whatsapp call.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Initiate Whatsapp Call\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create recreate evolution instance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/recreate_evolution_instance", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "recreate_evolution_instance" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates recreate evolution instance.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Recreate Evolution Instance\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create refresh whatsapp cloud status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/refresh_whatsapp_cloud_status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "refresh_whatsapp_cloud_status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates refresh whatsapp cloud status.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Refresh Whatsapp Cloud Status\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Register webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/register_webhook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "register_webhook" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates webhook.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Register Webhook\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Request whatsapp sync", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/request_whatsapp_sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "request_whatsapp_sync" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Requests whatsapp sync.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Request Whatsapp Sync\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reset secret", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/reset_secret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "reset_secret" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Resets secret.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Reset Secret\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Send call permission request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/send_call_permission_request", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "send_call_permission_request" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Sends call permission request.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Send Call Permission Request\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add or remove agent bot", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/set_agent_bot", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "set_agent_bot" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null", "body": { "mode": "raw", "raw": "{\n \"agent_bot\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Sync templates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/sync_templates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "sync_templates" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Handles sync templates.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Sync Template\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update calling settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/update_calling_settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "update_calling_settings" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates calling settings.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Update Calling Setting\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get contact", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:id/whatsapp_call_permission/:contact_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":id", "whatsapp_call_permission", ":contact_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" }, { "key": "contact_id", "value": "{{contact_id}}" } ] }, "description": "Returns contact." }, "response": [] }, { "name": "Delete assignment policy", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/assignment_policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "assignment_policy" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Deletes assignment policy." }, "response": [] }, { "name": "Get assignment policy", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/assignment_policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "assignment_policy" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Returns assignment policy." }, "response": [] }, { "name": "Create assignment policy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/assignment_policy", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "assignment_policy" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Creates assignment policy.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Assignment Policy\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get csat template", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/csat_template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "csat_template" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Returns csat template." }, "response": [] }, { "name": "Create csat template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/csat_template", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "csat_template" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Creates csat template.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Csat Template\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create disconnect", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/whatsapp_evolution/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "whatsapp_evolution", "disconnect" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Creates disconnect.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Disconnect\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Generate qr", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/whatsapp_evolution/generate_qr", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "whatsapp_evolution", "generate_qr" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Generates a QR code for device pairing.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Generate Qr\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get instance status", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/whatsapp_evolution/instance_status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "whatsapp_evolution", "instance_status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Returns instance status." }, "response": [] }, { "name": "List instances", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/whatsapp_evolution/list_instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "whatsapp_evolution", "list_instances" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Returns instances." }, "response": [] }, { "name": "Update instance settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/whatsapp_evolution/update_instance_settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "whatsapp_evolution", "update_instance_settings" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Updates instance settings.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Update Instance Setting\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update proxy settings", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/inboxes/:inbox_id/whatsapp_evolution/update_proxy_settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "inboxes", ":inbox_id", "whatsapp_evolution", "update_proxy_settings" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "inbox_id", "value": "{{inbox_id}}" } ] }, "description": "Updates proxy settings.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Update Proxy Setting\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Agentes", "item": [ { "name": "List Agents in Account", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Get Details of Agents in an Account" }, "response": [] }, { "name": "Add a New Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "agents" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Add a new Agent to Account", "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": [] }, { "name": "Bulk create", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/agents/bulk_create", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "agents", "bulk_create" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates records in bulk.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Bulk Create\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove an Agent from Account", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/agents/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Remove an Agent from Account" }, "response": [] }, { "name": "Update Agent in Account", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/agents/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Update an Agent in Account", "body": { "mode": "raw", "raw": "{\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update Agent in Account", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/agents/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "agents", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Update an Agent in Account", "body": { "mode": "raw", "raw": "{\n \"role\": \"agent\",\n \"availability_status\": \"available\",\n \"auto_offline\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Times", "item": [ { "name": "List all teams", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "List all teams available in the current account" }, "response": [] }, { "name": "Create a team", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Create a team in the account", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true,\n \"icon\": \"i-lucide-headphones\",\n \"icon_color\": \"#0EA5E9\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete a team", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Delete a team from the account" }, "response": [] }, { "name": "Get a team details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Get the details of a team in the account" }, "response": [] }, { "name": "Update a team", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Update a team's attributes", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true,\n \"icon\": \"i-lucide-headphones\",\n \"icon_color\": \"#0EA5E9\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a team", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Update a team's attributes", "body": { "mode": "raw", "raw": "{\n \"name\": \"Support Team\",\n \"description\": \"This is a team of support agents\",\n \"allow_auto_assign\": true,\n \"icon\": \"i-lucide-headphones\",\n \"icon_color\": \"#0EA5E9\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Remove an Agent from Team", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id/team_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Remove an Agent from Team", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Agents in Team", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id/team_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Get Details of Agents in an Team" }, "response": [] }, { "name": "Update Agents in Team", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id/team_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "All agents except the one passed in params will be removed", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Add a New Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/teams/:team_id/team_members", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "teams", ":team_id", "team_members" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "team_id", "value": "{{team_id}}" } ] }, "description": "Add a new Agent to Team", "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Labels", "item": [ { "name": "Update labels for kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates labels for kanban item." }, "response": [] }, { "name": "List all labels", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "List all labels available in the current account" }, "response": [] }, { "name": "Create a label", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "labels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Create a label in the account", "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": [] }, { "name": "Delete a label", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Delete a label from the account" }, "response": [] }, { "name": "Get a label", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Get the details of a label in the account" }, "response": [] }, { "name": "Update a label", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Update a label's attributes", "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": [] }, { "name": "Update a label", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "labels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Update a label's attributes", "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": [] } ] }, { "name": "Kanban (Funis e Cards)", "item": [ { "name": "List account kanban automations", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "automations" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns account Kanban automations. Administrator only." }, "response": [] }, { "name": "Create account kanban automation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/automations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "automations" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates an account Kanban automation. Administrator only." }, "response": [] }, { "name": "Delete account kanban automation", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "automations", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes an account Kanban automation. Administrator only." }, "response": [] }, { "name": "Show account kanban automation", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "automations", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns an account Kanban automation. Administrator only." }, "response": [] }, { "name": "Update account kanban automation", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "automations", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates an account Kanban automation. Administrator only." }, "response": [] }, { "name": "Replace account kanban automation", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/automations/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "automations", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates an account Kanban automation. Administrator only." }, "response": [] }, { "name": "List account funnels", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns only funnels authorized for the authenticated user. Administrators receive every funnel in the account." }, "response": [] }, { "name": "Create funnel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates a funnel. Administrator only.", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Sample resource\",\n \"stages\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"description\": \"Sample text\",\n \"active\": true,\n \"is_default\": true,\n \"unassigned_visibility\": \"everyone\",\n \"settings\": {\n \"agents\": [\n 1.0\n ],\n \"inboxes\": [\n 1.0\n ]\n },\n \"global_custom_attributes\": [\n {\n \"name\": \"Sample resource\",\n \"type\": \"Sample text\",\n \"is_list\": true,\n \"list_values\": [\n \"Sample text\"\n ]\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete funnel", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes a funnel and its associated items. Administrator only." }, "response": [] }, { "name": "Show funnel", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns a funnel when it is within the authenticated user's authorized scope." }, "response": [] }, { "name": "Update funnel", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a funnel. Administrators may update any funnel; `kanban_manage` may update only assigned funnels and cannot change the default or visibility mode.", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Sample resource\",\n \"description\": \"Sample text\",\n \"active\": true,\n \"is_default\": true,\n \"unassigned_visibility\": \"everyone\",\n \"stages\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"settings\": {\n \"agents\": [\n 1.0\n ],\n \"inboxes\": [\n 1.0\n ]\n },\n \"global_custom_attributes\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace funnel", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a funnel. Administrators may update any funnel; `kanban_manage` may update only assigned funnels and cannot change the default or visibility mode.", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Sample resource\",\n \"description\": \"Sample text\",\n \"active\": true,\n \"is_default\": true,\n \"unassigned_visibility\": \"everyone\",\n \"stages\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"settings\": {\n \"agents\": [\n 1.0\n ],\n \"inboxes\": [\n 1.0\n ]\n },\n \"global_custom_attributes\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Reorder funnel stages", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:id/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":id", "reorder" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Reorders funnel stages. Administrators may reorder any funnel; `kanban_manage` may reorder only assigned funnels." }, "response": [] }, { "name": "Get funnel stage metrics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:id/stage_stats", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":id", "stage_stats" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns stage metrics for a funnel within the authenticated user's authorized scope." }, "response": [] }, { "name": "List funnels under kanban namespace", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/funnels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "funnels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns only funnels authorized for the authenticated user. Administrators receive every funnel in the account." }, "response": [] }, { "name": "Create funnel under kanban namespace", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/funnels", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "funnels" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates a funnel under the Kanban namespace. Administrator only.", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Sample resource\",\n \"stages\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"description\": \"Sample text\",\n \"active\": true,\n \"is_default\": true,\n \"unassigned_visibility\": \"everyone\",\n \"settings\": {\n \"agents\": [\n 1.0\n ],\n \"inboxes\": [\n 1.0\n ]\n },\n \"global_custom_attributes\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete funnel under kanban namespace", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes a funnel and its associated items. Administrator only." }, "response": [] }, { "name": "Show funnel under kanban namespace", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns a funnel when it is within the authenticated user's authorized scope." }, "response": [] }, { "name": "Update funnel under kanban namespace", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a funnel. Administrators may update any funnel; `kanban_manage` may update only assigned funnels and cannot change the default or visibility mode.", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Sample resource\",\n \"description\": \"Sample text\",\n \"active\": true,\n \"is_default\": true,\n \"unassigned_visibility\": \"everyone\",\n \"stages\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"settings\": {\n \"agents\": [\n 1.0\n ],\n \"inboxes\": [\n 1.0\n ]\n },\n \"global_custom_attributes\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace funnel under kanban namespace", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/funnels/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "funnels", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a funnel. Administrators may update any funnel; `kanban_manage` may update only assigned funnels and cannot change the default or visibility mode.", "body": { "mode": "raw", "raw": "{\n \"funnel\": {\n \"name\": \"Sample resource\",\n \"description\": \"Sample text\",\n \"active\": true,\n \"is_default\": true,\n \"unassigned_visibility\": \"everyone\",\n \"stages\": {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n },\n \"settings\": {\n \"agents\": [\n 1.0\n ],\n \"inboxes\": [\n 1.0\n ]\n },\n \"global_custom_attributes\": [\n {\n \"source\": \"api\",\n \"segment\": \"enterprise\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List stages for a funnel", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "stages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns stages only for a funnel within the authenticated user's authorized scope." }, "response": [] }, { "name": "Create stage in a funnel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/stages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "stages" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates a stage in a funnel. Administrators may use any funnel; `kanban_manage` may use only assigned funnels." }, "response": [] }, { "name": "Delete stage", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/stages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "stages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes a stage. Administrators may use any funnel; `kanban_manage` may use only assigned funnels." }, "response": [] }, { "name": "Show stage", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/stages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "stages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns a stage only when its funnel is within the authenticated user's authorized scope." }, "response": [] }, { "name": "Update stage", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/stages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "stages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a stage. Administrators may use any funnel; `kanban_manage` may use only assigned funnels." }, "response": [] }, { "name": "Replace stage", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/stages/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "stages", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates a stage. Administrators may use any funnel; `kanban_manage` may use only assigned funnels." }, "response": [] }, { "name": "List kanban items for funnel", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/funnels/:funnel_id/kanban_items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "funnels", ":funnel_id", "kanban_items" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "funnel_id", "value": "{{funnel_id}}" } ] }, "description": "Returns only Kanban items authorized for the caller in the requested funnel. For a valid linked conversation, the conversation assignee and manually assigned item agents can both view the item; a stale link is visible only to administrators and the creator." }, "response": [] }, { "name": "Get items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns items." }, "response": [] }, { "name": "Create items", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates items.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Item\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete items", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes items." }, "response": [] }, { "name": "Get items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns items." }, "response": [] }, { "name": "Update items", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates items.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Item\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Replace items", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates items.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Sample Item\",\n \"description\": \"Created from the API documentation example\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List kanban item attachments", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:item_id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":item_id", "attachments" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "item_id", "value": "{{item_id}}" } ] }, "description": "Returns kanban item attachments." }, "response": [] }, { "name": "Upload kanban item attachment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:item_id/attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":item_id", "attachments" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "item_id", "value": "{{item_id}}" } ] }, "description": "Uploads kanban item attachment." }, "response": [] }, { "name": "Delete kanban item attachment", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:item_id/attachments/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":item_id", "attachments", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "item_id", "value": "{{item_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes kanban item attachment." }, "response": [] }, { "name": "Upload note attachment for kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:item_id/note_attachments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":item_id", "note_attachments" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "item_id", "value": "{{item_id}}" } ] }, "description": "Uploads note attachment for kanban item." }, "response": [] }, { "name": "Delete note attachment for kanban item", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban/items/:item_id/note_attachments/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban", "items", ":item_id", "note_attachments", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "item_id", "value": "{{item_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes note attachment for kanban item." }, "response": [] }, { "name": "Delete kanban configuration", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_config" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Deletes global Kanban configuration. Administrator only." }, "response": [] }, { "name": "Show kanban configuration", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_config" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns global Kanban configuration for a Kanban actor (`agent`, `kanban_view`, `kanban_manage`, or administrator)." }, "response": [] }, { "name": "Update kanban configuration", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_config" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Updates global Kanban configuration. Administrator only." }, "response": [] }, { "name": "Create kanban configuration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_config" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates global Kanban configuration. Administrator only." }, "response": [] }, { "name": "Replace kanban configuration", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_config" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Updates global Kanban configuration. Administrator only." }, "response": [] }, { "name": "List kanban items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns only Kanban items authorized for the caller. With a valid linked conversation, both its assignee and manually assigned item agents can view the item even when they differ; a stale link is visible only to administrators and the creator. Unassigned items follow the funnel's `unassigned_visibility` mode." }, "response": [] }, { "name": "Create kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Creates kanban item." }, "response": [] }, { "name": "Batch list kanban items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/batch", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "batch" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns authorized Kanban items and aggregated metadata in batch mode." }, "response": [] }, { "name": "Bulk assign agent to kanban items", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/bulk_assign_agent", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "bulk_assign_agent" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Applies bulk assign agent to kanban items." }, "response": [] }, { "name": "Bulk move kanban items", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/bulk_move_items", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "bulk_move_items" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Applies bulk move kanban items." }, "response": [] }, { "name": "Bulk set kanban items priority", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/bulk_set_priority", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "bulk_set_priority" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Applies bulk set kanban items priority." }, "response": [] }, { "name": "Export kanban items as CSV", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/export", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "export" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Exports only Kanban items authorized for the caller as CSV." }, "response": [] }, { "name": "Filter kanban items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/filter", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "filter" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Filters only Kanban items authorized for the caller." }, "response": [] }, { "name": "Import kanban items", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "import" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Imports kanban items." }, "response": [] }, { "name": "Preview kanban import file", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/import_preview", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "import_preview" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Previews kanban import file." }, "response": [] }, { "name": "Reorder kanban items", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/reorder", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "reorder" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Reorders kanban items." }, "response": [] }, { "name": "Get kanban report metrics", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/reports", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "reports" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Returns report metrics calculated from Kanban items authorized for the caller." }, "response": [] }, { "name": "Search kanban items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", "search" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" } ] }, "description": "Searches only Kanban items authorized for the caller." }, "response": [] }, { "name": "Delete kanban item", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes kanban item." }, "response": [] }, { "name": "Show kanban item", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns a Kanban item only when it is authorized for the caller. A manual item assignment is not overridden by a different assignee on a valid linked conversation; stale links remain visible only to administrators and the creator." }, "response": [] }, { "name": "Update kanban item", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates kanban item." }, "response": [] }, { "name": "Replace kanban item", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates kanban item." }, "response": [] }, { "name": "Assign agent to kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/assign_agent", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "assign_agent" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Assigns agent to kanban item." }, "response": [] }, { "name": "Assign agent to checklist item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/assign_agent_to_checklist_item", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "assign_agent_to_checklist_item" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Assigns agent to checklist item." }, "response": [] }, { "name": "List assigned agents for kanban item", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/assigned_agents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "assigned_agents" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns assigned agents for kanban item." }, "response": [] }, { "name": "Change kanban item status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/change_status", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "change_status" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Changes kanban item status." }, "response": [] }, { "name": "Get checklist progress by agent", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/checklist_progress_by_agent", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "checklist_progress_by_agent" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns checklist progress by agent." }, "response": [] }, { "name": "Get counts for notes, checklist, and attachments", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/counts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "counts" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns counts for notes, checklist, and attachments." }, "response": [] }, { "name": "Create checklist item for kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/create_checklist_item", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "create_checklist_item" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates checklist item for kanban item." }, "response": [] }, { "name": "Create note for kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/create_note", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "create_note" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Creates note for kanban item." }, "response": [] }, { "name": "Delete checklist item from kanban item", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/delete_checklist_item", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "delete_checklist_item" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes checklist item from kanban item." }, "response": [] }, { "name": "Delete note from kanban item", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/delete_note", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "delete_note" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes note from kanban item." }, "response": [] }, { "name": "Duplicate checklist to another kanban item", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/duplicate_checklist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "duplicate_checklist" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Duplicates checklist to another kanban item." }, "response": [] }, { "name": "Get checklist for kanban item", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/get_checklist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "get_checklist" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns checklist for kanban item." }, "response": [] }, { "name": "Get notes for kanban item", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/get_notes", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "get_notes" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns notes for kanban item." }, "response": [] }, { "name": "Move kanban item between funnel or stage", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/move", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "move" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Moves kanban item between funnel or stage." }, "response": [] }, { "name": "Move kanban item to stage", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/move_to_stage", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "move_to_stage" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Moves kanban item to stage." }, "response": [] }, { "name": "Remove agent from kanban item", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/remove_agent", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "remove_agent" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes agent from kanban item." }, "response": [] }, { "name": "Remove agent from checklist item", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/remove_agent_from_checklist_item", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "remove_agent_from_checklist_item" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Deletes agent from checklist item." }, "response": [] }, { "name": "Search checklist items", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/search_checklist", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "search_checklist" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns checklist items." }, "response": [] }, { "name": "Get time breakdown by stage", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/stage_time_breakdown", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "stage_time_breakdown" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns time breakdown by stage." }, "response": [] }, { "name": "Get total tracked time for kanban item", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/time_report", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "time_report" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Returns total tracked time for kanban item." }, "response": [] }, { "name": "Toggle checklist item completion", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/toggle_checklist_item", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "toggle_checklist_item" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Toggles checklist item completion." }, "response": [] }, { "name": "Update checklist item for kanban item", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/update_checklist_item", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "update_checklist_item" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates checklist item for kanban item." }, "response": [] }, { "name": "Update note for kanban item", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "api_access_token", "value": "{{token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/api/v1/accounts/:account_id/kanban_items/:id/update_note", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "accounts", ":account_id", "kanban_items", ":id", "update_note" ], "query": [], "variable": [ { "key": "account_id", "value": "{{account_id}}" }, { "key": "id", "value": "{{id}}" } ] }, "description": "Updates note for kanban item." }, "response": [] } ] } ] }