{ "item": [ { "name": "Conversations", "description": "Tickets and their thread events (replies, notes, drafts, scheduled replies, spam, snooze, merge, split, move, tags).", "item": [ { "id": "9e7e1b8c-2969-4a75-b0a1-420870dd4b1d", "name": "View a conversation", "request": { "name": "View a conversation", "description": { "content": "View a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7b8534a6-d1e8-4b3f-b54a-ccca2edfe1cd", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"conversation\": {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Pending\",\n \"is_spam\": \"\",\n \"priority\": \"Medium\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\",\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#fe0cF0\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#b7A9Dc\"\n }\n ]\n },\n \"events\": {\n \"data\": [\n {\n \"id\": \"\",\n \"action\": \"\",\n \"created_at\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"event\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"downloadable_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n }\n ],\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"actor_id\": \"\",\n \"actor_type\": \"\",\n \"actor\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"extra\": {},\n \"conversation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"action\": \"\",\n \"created_at\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"event\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": null,\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"downloadable_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n }\n ],\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"actor_id\": \"\",\n \"actor_type\": \"\",\n \"actor\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"extra\": {},\n \"conversation_id\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\",\n \"path\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f70c8a48-6d0d-492d-bfe4-e1bb1bcf7baf", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b58886e2-eae2-4119-8dbb-b5e8baa5ad2f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37a82017-a237-4c02-8eb2-a26dc124c107", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f94f624-1b60-4554-869e-b136116b86f3", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65d0717e-8f63-4983-8729-c0c64cac5605", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8d62d80-27b3-47e1-9923-fbc8ab79c962", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "36fe81e9-c8e7-49cb-85f1-fc752cf681a2", "name": "Update a conversation", "request": { "name": "Update a conversation", "description": { "content": "Update a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b6a7b810-bc8a-4610-a6cf-d4dbd75f5b1b", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5440160-1035-4a20-b101-0e6b0994346f", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66882a4a-9fbe-47bb-8a04-4cbcba79378a", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8d99289-2cb2-4be3-91ab-e03eb1bed279", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47793066-848c-4b81-b187-810d36eb5c8b", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3f24fa7-a078-41fd-9c65-5796b614731f", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce908b26-d633-4da4-9888-c9fd4030b6bd", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"intended_inbox_address_id\": \"\",\n \"subject\": \"\",\n \"custom_fields\": {\n \"key_0\": 5492.194030669135\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "29a0e70f-455e-4303-b5bf-f8280cb46307", "name": "Delete a conversation", "request": { "name": "Delete a conversation", "description": { "content": "Delete a conversation.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "031b1c0f-93ac-413d-ae42-e3e1d41960b5", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "338cff90-b929-4414-9122-1bb8456796b1", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1611f480-43b1-46cf-8882-ae04e6a2c5c6", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ab543f1-a73b-44dd-b17c-a36c57dc56ba", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fce07ea-d998-4800-8199-a41d066b8f49", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4eb9a79-2791-4b60-883c-1d2658d0516d", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aed48dee-08b6-44f5-b3ac-870612c5dd7e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31e82f5d-c7fb-458b-b502-4e6398a88f4a", "name": "Change the contact on a conversation", "request": { "name": "Change the contact on a conversation", "description": { "content": "Change the contact on a conversation.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "82eec604-be2e-4a9b-b165-bbeaea91ec16", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4768c526-71bd-407b-871a-edb3e2d2ba86", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95baf4b7-5a33-45a8-b10b-f9084386e50f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8aea9e0e-f405-498c-9d83-d034cfe11348", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ef5bf85-3115-43da-b6be-51c4fada1062", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c455efb3-8b3c-4862-857d-75509517ebde", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73c37f68-e33f-4d8a-89c6-ab123dc1f9fe", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "change-contact" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"contact_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7c27f784-0f40-4a28-9365-635101320880", "name": "Update custom field values on a conversation", "request": { "name": "Update custom field values on a conversation", "description": { "content": "Update custom field values on a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "eb8eb806-d2c6-4cd3-9489-28592b248fdf", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7c04783-3ac7-4b17-9eb9-4a9822a5b5fa", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6af6b3d7-4254-45b8-abf8-de782773a45b", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "101b9842-0150-4bb5-a602-1f5bb55cd223", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1fb47b6-0ca4-4baa-ab7b-e4eae47f168d", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea75e5f1-dd85-4580-afa6-8c9c4a0ac847", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcb5ec44-00d6-4073-9033-ecaa8e57ef6b", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "07af737c-0258-4ea4-aa30-d7615a10d6b0", "name": "Create or update the reply draft", "request": { "name": "Create or update the reply draft", "description": { "content": "Create or update the reply draft.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "94ab7b83-b401-4ec9-873a-d28871a8226a", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"draft_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0849dffe-820e-453f-bb51-899ff4e0a8c0", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5b6a59b-77fa-4155-b2f6-aab5dc364153", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77899880-df1c-48e6-83ce-f8a0702293f6", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2b0e247-b14b-460b-ab03-5c650f216350", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8561c5ac-6dd6-432f-8c4b-43bb6a1078b9", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebe9cc03-e2d1-41d4-a0b5-0cfdfcec6224", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "draft" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46ae04bb-0969-4851-a413-2adff186aa88", "name": "Permanently delete a conversation", "request": { "name": "Permanently delete a conversation", "description": { "content": "Irreversible. The conversation must already be in the trash, so soft-delete it with `DELETE /v1/conversation/{conversation_id}` first; calling this on a live conversation returns 404.\n\nEverything hanging off the conversation goes with it: thread events, messages, attachments and the files behind them in object storage, tag links, and custom field values. There is no restore afterwards.\n\nTrashed conversations are also purged automatically once they pass the organization's trash lifetime (30 days by default).\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0e3537f9-cc08-4a1b-a356-f99c612e28b7", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b89249e-fa41-4308-bd87-5ae69c894b24", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6789c378-5f47-485c-a47c-c4b667df0234", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "719fbc91-2e7e-4164-8653-7cd8d96dd72f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ac70b2f-c44f-414d-b131-5bae8c898a5a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b398b86-e011-41c6-be6a-3c73e07db982", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d5d002c-46a3-41f1-b35d-129df9c659b7", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "force-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7e7b1606-0a8c-4b68-b982-454e9c1db3a9", "name": "Forward a conversation", "request": { "name": "Forward a conversation", "description": { "content": "Forward a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fe791535-d591-4e8c-b030-f27b3a7a3ea4", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec83b195-3494-44e2-96f6-408ca12c2c49", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8b64800-51fc-4da1-b2c0-8628d727665c", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0770642e-221f-430b-9a64-36d1e3ae6407", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60421168-8c37-4522-a774-e7af9dd654f1", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89f1607c-3a19-493e-8a53-4e52947c076f", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36516d2c-161b-4a3f-a962-cae9256a254f", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "forward" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"body\": \"\",\n \"message_id\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"attachment_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "54506614-5cb3-4d15-9591-98683a325034", "name": "Merge other conversations into this one", "request": { "name": "Merge other conversations into this one", "description": { "content": "Merge other conversations into this one.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4bda04cf-6809-4783-8dc8-da4be2bcc8fe", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d777695-f6ee-428a-910a-e672e3284c28", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9101e434-d3ec-4291-a3d1-6e3c3a6b129a", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51c6448d-1b3c-4cd3-a37f-1c70f4ec3fce", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6d9e38d-b767-448d-af10-67aa8902ff7e", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61abae30-3a55-4489-acdb-0557f0ec294e", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "802bdb75-f4b4-427f-aa98-3f7dd7d7e743", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mergeable_conversation_ids\": [\n \"\"\n ],\n \"include_notes\": \"\",\n \"include_merge_summary\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1ff3991b-117e-46fb-a1c6-cc80b8d242f4", "name": "Get thread messages for a conversation", "request": { "name": "Get thread messages for a conversation", "description": { "content": "Get thread messages for a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "10bc22f1-2931-448a-a25b-eecd8de98c7b", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"event\": [\n {\n \"id\": \"\",\n \"action\": \"\",\n \"created_at\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"event\": {\n \"id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"downloadable_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n }\n ],\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"actor_id\": \"\",\n \"actor_type\": \"\",\n \"actor\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"extra\": {},\n \"conversation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"action\": \"\",\n \"created_at\": \"\",\n \"event_id\": \"\",\n \"event_type\": \"\",\n \"event\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": null,\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"downloadable_attachments\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"url\": \"\",\n \"download_url\": \"\"\n }\n ],\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"actor_id\": \"\",\n \"actor_type\": \"\",\n \"actor\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"extra\": {},\n \"conversation_id\": \"\"\n }\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"extra\": {},\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"inbox\": \"\",\n \"subject\": \"\",\n \"ticket_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76a6ccfd-19d3-40f3-be8d-a6f81eb4f860", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee00ec2-0d9f-4570-ac25-c8b6a4b465b8", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d371869-88b0-408f-82fc-cda00fb4671e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6d50616-f8cc-4b94-9fe7-8d28bf1edb5a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b78d85c-c918-4159-ad2e-bec8b45ec871", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06158edb-1a26-45b6-8b8f-fbb2b3a07502", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Return only the thread event with this message ID.", "type": "text/plain" }, "key": "event_id", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "64df66e2-4685-4e93-805b-c5e334c80486", "name": "Move a conversation to another inbox", "request": { "name": "Move a conversation to another inbox", "description": { "content": "Move a conversation to another inbox.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "12eadb70-9276-421c-bf99-bfb5a1ad9916", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f47f1b7-a0ce-45b5-b3b1-153f82ed8fc9", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d97320d3-f2c5-41e6-bdad-b0d6c1015f55", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bce9f6a-173a-4f7c-a2a9-ed10f62acc8b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b807a23e-b637-40c2-a5b4-d94ec6aad946", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "119656a5-f8ab-4716-a62e-3ff6141d564b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c87cff0-f776-4592-a594-db1f82e3e7e4", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "move" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2583c539-95e9-40b6-8daf-dd6c08285ee6", "name": "Add an internal note", "request": { "name": "Add an internal note", "description": { "content": "Add an internal note.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db74fd61-3be6-4fc6-97a9-a1a0129c6489", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e899a4-acbb-4cde-b598-7fbb54119262", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d5afe08-f76e-4a21-926e-4974ff7f58a8", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa5f557c-0792-47af-96e5-fa0a7751951c", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bff72bf-ebfc-46bd-bc7e-7d874200349a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a14bb5a4-8f4b-410e-a05f-e3a8a6d33e93", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27c0847c-b44c-48ef-869d-87a666d457e4", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "note" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"mentioned_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "596fef28-ab8a-4558-a326-f7d4ff8c2c64", "name": "Reply to a conversation", "request": { "name": "Reply to a conversation", "description": { "content": "Reply to a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e39a4987-e234-406b-8a28-e70026253155", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ddc3e39-6cb5-428b-ac66-5c4a04cb352f", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d5c2b55-d2c6-47d4-82be-159cf876d4a5", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc2305ec-a685-4236-8c07-7622e3594466", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4599049-afd5-479e-9e6e-be4e12b65cb1", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba49f074-e4cd-42f3-97ac-e6f0c878bd7a", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90773aad-0fa8-46e9-b359-6dc0c9c5c71c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"status\": \"Closed\",\n \"assign_to\": \"\",\n \"action\": \"send_and_back_to_folder\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5a1af480-aeba-474d-bf69-2a5a03dee230", "name": "Schedule a reply", "request": { "name": "Schedule a reply", "description": { "content": "Schedule a reply.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "92d75cac-55c6-42cf-a416-2d3ba26a971a", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "113ebc5d-db08-4d75-a26d-ead640e8546b", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2b366d5-c242-4cda-b8f0-860b483ab9aa", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15b7f970-844b-4556-957c-8a1c1834eef0", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95eaacab-3a5b-4d90-83ea-a7090a88d764", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a27d1c5-08d0-4bed-a3f1-72369d4aaa19", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a299fe1c-b9e7-4b96-a8ff-53f83d07e110", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "schedule" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"if_no_reply\",\n \"status\": \"Pending\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f2ad5560-cf48-48be-9e88-6014068a544d", "name": "Cancel a scheduled reply", "request": { "name": "Cancel a scheduled reply", "description": { "content": "Cancel a scheduled reply.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "25c158aa-5c11-43ed-9409-3078ec251545", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49ea721e-eff9-4e80-ba57-037d4ac0808d", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f00fc21b-5740-477a-b1c5-8711f550b279", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92ec5537-27e4-4aaa-b3cb-a2ae003de442", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "009e1298-262c-4882-ad48-462234c2c77e", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c43d1de5-0c8f-4a06-911e-95afee092fff", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d57e1d4-911c-4e35-94d2-d37d41593591", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "reply", "unschedule", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e682f14e-f12d-4564-bcce-67b086e70e2b", "name": "Restore a trashed conversation", "request": { "name": "Restore a trashed conversation", "description": { "content": "Restore a trashed conversation.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e13ca227-1c93-49fd-9281-8d7fb8f6a661", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5acfbae1-96f5-4b63-9be8-bb10015afe9f", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fbfa23d-2526-4693-8a05-4ca13341ea7a", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea141527-1d5b-41b4-bdee-55abe576baca", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf953e03-9498-40a9-bdfc-2e99f5d0c2dc", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6cea1df6-f275-4127-89c7-e6af9df4217a", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68b70ea9-ad29-44e8-aaf6-745a2ae1da8e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e0ea82e-2a6a-45b4-b820-937e16babd33", "name": "Update a scheduled reply", "request": { "name": "Update a scheduled reply", "description": { "content": "Update a scheduled reply.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "04e1d007-ddf4-4784-9451-f522cdc41478", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "608f00d9-a558-4ae0-9ebd-3eec90b9fdaf", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2188682-4698-4f54-ad5d-db7385dba0a9", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "262eb512-d254-4a0f-a17c-f3b686ba1e3e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "defc3216-6a8d-440c-9d3c-7ff8b1d974ca", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e06012-5a38-4245-a5b0-e75b3c6fb743", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2d1f626-529f-44ca-9e71-c7405b2304fc", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"message\": \"\",\n \"scheduled_at\": \"\",\n \"type\": \"regardless\",\n \"status\": \"Active\",\n \"assign_to\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b7e4d0d-18b6-488a-a29f-14aa7c91e6d9", "name": "Send a scheduled reply now", "request": { "name": "Send a scheduled reply now", "description": { "content": "Send a scheduled reply now.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "01c2e4d6-cbd6-4830-8789-90f586252d64", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd4bb453-12f6-4cdd-9aee-0d67837a8560", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63b81ea2-5302-4376-83f3-e5edf592ad1a", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2850033-cae3-49e3-91a5-24363e6bfb0b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bada1b7b-8241-4148-b0e5-28f9be9225a1", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ded5dabb-6622-49e7-a4b1-1e8482857277", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc0570c2-7583-4804-b2cd-4bc59e6f467e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "scheduled", ":message_id", "send-now" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e72b568-d7d7-43f6-a783-be2eebb8646b", "name": "Snooze a conversation", "request": { "name": "Snooze a conversation", "description": { "content": "Snooze a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7013ef5f-8a6b-4cd7-9d05-0b25bd5ff881", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdca2664-770c-4906-a233-16afaa98ab91", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a41b78b-8daa-449c-9767-a302b3fca906", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d640093f-0b6d-495e-b8ec-e027c9591ed8", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f250bc3d-d66e-4006-82a3-d36a93de3892", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27590822-290e-4a0c-95e7-81cc294e29ed", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5053205c-de3f-4579-9a02-eca363ab5dfc", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "snooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"snoozed_until\": \"\",\n \"type\": \"regardless\",\n \"is_updating\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "676a41ba-53a0-4255-ba5c-d0932e1c8dda", "name": "Mark a conversation as spam", "request": { "name": "Mark a conversation as spam", "description": { "content": "Mark a conversation as spam.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9f90d3b1-110b-454b-aafa-0529143e7fcc", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f4458bc-3c89-49e1-9984-443fc3883930", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e7a782e-9bc3-4514-8031-e64f96e1dea1", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a27ac28-89a5-44b3-914f-a87d9e122f45", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e59e0a06-399e-4e22-9301-a6cf44feb4d6", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4423987-1e91-4ab4-b018-7bda50f119e7", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "679b8a77-6cd9-4d8e-b3a8-e330f5b3b6c5", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c17419c4-c198-4c92-a698-e5ee28959808", "name": "Unmark a conversation as spam", "request": { "name": "Unmark a conversation as spam", "description": { "content": "Unmark a conversation as spam.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8b43ee23-a466-4e70-9b5b-181db61189d6", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10b9a034-7564-44a9-af05-6f83c4d399c0", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7db0a79-d671-4b36-b6c3-b8e1041b757f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74b4e50-bb6f-46a7-8e1f-072d80b6e9a0", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba8adb68-21ba-49e9-bd68-0404bede3aee", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b989e10-a65b-4461-af69-d3ba4e0c088e", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66b31259-08b5-487d-a202-435a1f8757de", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "spam" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f72c34a-68a4-4970-a7f5-82a7e9c5e39f", "name": "Split a conversation at a message", "request": { "name": "Split a conversation at a message", "description": { "content": "Split a conversation at a message.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "99f12df9-0c9e-484d-84fb-d02eea5dd198", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "add13d19-d260-4933-bc93-34203ee1b7f2", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "878c3f57-cc05-4010-b23f-2662dd298cc8", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89317d98-604c-4dc0-a6cc-d048cd8e4eee", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c14fa7-d476-4846-9192-0a87e16efdc1", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59eca118-c723-4afd-8679-44e10c519d50", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfba884f-5846-4eb0-a70d-0b6e013cf552", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "split" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"thread_event_id\": \"\",\n \"direction\": \"before\",\n \"subject\": \"\",\n \"status\": \"Pending\",\n \"additional_note\": \"\",\n \"priority\": \"Low\",\n \"labels\": [\n \"\",\n \"\"\n ],\n \"assignable_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9c4581c5-a9b7-4559-b166-045471eb656f", "name": "Attach a tag", "request": { "name": "Attach a tag", "description": { "content": "Attach a tag.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e2f0eecc-d513-4980-9a7e-db3a3ab310b0", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc96b3b5-d83d-4ec0-926d-4ad2719dc62a", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b78d8a43-7f1d-4125-99d7-ffdc1810cf62", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93a445d5-79f9-41e7-9640-c58b555f9be2", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bb13adc-a1d5-4d5b-a8fb-9d2bc651b0bf", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84275286-e363-4390-a713-4d06910105ac", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f61a4f38-72ce-4996-80f1-42fbf1eaf287", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b868dd7a-eff9-4445-8f53-b655ad11c5e2", "name": "Detach a tag", "request": { "name": "Detach a tag", "description": { "content": "Detach a tag.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "863f38e5-547e-4963-a4da-376a19110d23", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38263acd-733d-4a02-845f-1111333adcd7", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "595c63c0-e57a-45f9-a970-6a0665596e6a", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec3dec85-b934-448d-b482-2c8dd6a90e90", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b663a491-e4a8-435a-acc5-e978cffa760b", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69dea5c5-33b4-4383-91e3-e18f98e69b11", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ee2655-87f4-4a1f-9b35-ee29d330c993", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": { "mode": "raw", "raw": "{\n \"tag\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3438bd10-8ae3-4003-8e99-748dc7593a73", "name": "Unsnooze a conversation", "request": { "name": "Unsnooze a conversation", "description": { "content": "Unsnooze a conversation.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d44a9094-0f96-44e7-bc65-e456b1774bc0", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853ca82a-3300-44d6-9f14-8558d7c6e3b6", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45f77e12-0dc8-411d-a73c-d2061db63b35", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d632803-514c-4915-837c-87561d9e6457", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "472a60c2-1cfe-4b58-a770-b79b0f92fa6d", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1cc6ab-4aee-4322-8752-2287025b488d", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0753ff0b-e55e-4987-9273-6b5d1fcbea0c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "unsnooze" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0575c2a9-3f53-4458-b4fe-c8cafbe54b88", "name": "Update a conversation's priority", "request": { "name": "Update a conversation's priority", "description": { "content": "Update a conversation's priority.", "type": "text/plain" }, "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversation_id", "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a43e2fb0-bb15-4f68-aeff-7634c25a9644", "name": "Success.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b8cb9c9-d6df-43fc-ae51-5c868c91d986", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "604ee3eb-19bd-4846-88a0-6cce90479ddd", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1fb4f5e9-be91-4890-880f-8fb0ee791910", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d350ab4f-2c7f-43d8-810a-a11c9ae2e0c0", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c17f211-5e8e-4422-b8f9-db0ee92d8e16", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5362dfde-4e98-4ce3-86e9-086b006fe364", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversation", ":conversation_id", "update", "priority" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversation_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"priority\": \"Low\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d5a30556-1224-4241-af3d-a3e427459653", "name": "List conversations assigned to the current user", "request": { "name": "List conversations assigned to the current user", "description": { "content": "List conversations assigned to the current user.", "type": "text/plain" }, "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a50f681f-46d9-4e80-9cd0-367a31f7a85c", "name": "Success.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Closed\",\n \"is_spam\": \"\",\n \"priority\": \"High\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": null,\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n },\n {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Active\",\n \"is_spam\": \"\",\n \"priority\": \"Low\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": null,\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e906d64-5f08-4fc4-be3f-820446065d80", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fc9b195-e3d8-4956-953d-23be5a8afe17", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59378d62-62b4-49f3-bac0-0d74b3b4f1c6", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e425d409-b992-4b69-835f-78b65028ef0d", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3458e7f2-a1ca-4db1-987c-572fd1fdbea3", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81ae5efc-ddeb-46e0-9dc1-eeb808f08961", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "conversations", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Contacts", "description": "People who send and receive messages.", "item": [ { "id": "aa635974-7771-47cb-9220-8842e7301e6f", "name": "List contacts", "request": { "name": "List contacts", "description": { "content": "List contacts.", "type": "text/plain" }, "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b754632c-c5d0-43f7-b607-0ae616e3eda8", "name": "Success.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\",\n \"path\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4daf66b9-2307-4f38-bb78-acfd8c1eb7cd", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a312f8a5-2d0c-49ba-af0d-15a402ca1f96", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a289ace4-ffd9-43c0-8278-392430bdc648", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a24f8ea4-f188-44a6-927f-f073bb073494", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dda25f23-6814-4478-a01c-a59bb063efee", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00be29ae-b585-4696-9775-7dd0a73e9102", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search by name or email.", "type": "text/plain" }, "key": "q", "value": "" }, { "disabled": false, "description": { "content": "Only contacts with conversations in this inbox.", "type": "text/plain" }, "key": "inbox", "value": "" }, { "disabled": false, "description": { "content": "Include contacts with no conversations.", "type": "text/plain" }, "key": "with_orphan", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4d18fea6-8fc5-4258-b2b9-49fd11e6b232", "name": "Create a contact", "request": { "name": "Create a contact", "description": { "content": "Create a contact.", "type": "text/plain" }, "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "24451bb0-a1ed-41b0-93e8-dc489332da5d", "name": "Success.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d31ee6d-3934-4bf1-99d8-6d7a5b4f0579", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ad9e9e1-7c8c-4444-beb7-5e4e96f8bd7e", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8002b81c-8bef-4b13-9fae-e2f7f8dbb275", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "628d02c8-dc26-4bc7-b3bd-3987b16598ed", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36317119-0b56-4450-8851-1cd01bc07926", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "393c95cf-6cb1-4ec7-a9d9-396df058c061", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f6ec669e-19c2-4396-a5d5-7e6e66035ef9", "name": "View a contact", "request": { "name": "View a contact", "description": { "content": "View a contact.", "type": "text/plain" }, "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "contact_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0d7aedb9-0b3c-4401-948f-102a66b9628e", "name": "Success.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "460760fe-e15c-4e97-bb78-4b7bddaa1557", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33c76e3-2180-461b-8b1b-9165744177d5", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92bbf393-029f-4a5e-a0d0-9a9a09a1830e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "069645dc-70b8-4356-acf4-85af42a0b8ea", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b91a877-eaae-4535-bb42-f15de9c4e216", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c36cd97-6b6a-4228-abb0-e9c4c3b5d0bd", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4aaf6d2c-dc30-4baa-8b31-aea8bfed6238", "name": "Update a contact", "request": { "name": "Update a contact", "description": { "content": "Update a contact.", "type": "text/plain" }, "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "contact_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bea147bc-2461-4cf7-aea8-e0b638aaa3f1", "name": "Success.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b53a2b7-5734-49a9-b6e4-9ffbf51858d2", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ae4ab15-daad-4d45-8e5c-9bf2bc7d9364", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "968b110a-d595-40cf-8211-1e92dd5298cf", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27d0a4eb-ce9c-4dfd-8df1-1e2b91f8bab3", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "822192dc-a7d4-48e3-9796-1a55864fb8fe", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "655a644b-1246-464d-ac30-39e2b2c444e8", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"company\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"notes\": \"\",\n \"should_display_image\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dba8e316-b24b-42bf-8a5c-d81f87d7dc47", "name": "List conversations for a contact", "request": { "name": "List conversations for a contact", "description": { "content": "List conversations for a contact.", "type": "text/plain" }, "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "contact_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "335b3c42-0b68-4d71-b545-007bbc27a23b", "name": "Success.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"conversations\": [\n {\n \"id\": \"\",\n \"subject\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"excerpt\": \"\",\n \"inbox_id\": \"\",\n \"priority\": \"\",\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#a01B2b\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#eA3dA2\"\n }\n ],\n \"last_message_by\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"subject\": \"\",\n \"status\": \"\",\n \"type\": \"\",\n \"excerpt\": \"\",\n \"inbox_id\": \"\",\n \"priority\": \"\",\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#88d7d1\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#04A8dB\"\n }\n ],\n \"last_message_by\": \"\",\n \"created_at\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cfe4425-3b69-45ba-a8d2-26ff77787212", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1facf3-58a5-4eb5-8362-ed51f3978d7a", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e831c2e-e04a-481e-a174-f356419e2863", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45ef599-c1dc-43c0-a81b-9ffbe61c7d98", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfcf36a3-8e75-4ea5-a90b-9aa4cdbb6cea", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41cd5d51-676e-4213-96ae-07cadf011c5d", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "contacts", ":contact_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only conversations in this inbox.", "type": "text/plain" }, "key": "inbox_id", "value": "" }, { "disabled": false, "description": { "content": "Conversation ID to exclude.", "type": "text/plain" }, "key": "except", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of conversations to return.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "contact_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Inboxes", "description": "Mailboxes/channels and their automations, custom fields, and saved replies.", "item": [ { "id": "fda903d6-f6df-4ee7-99d5-f9f9daf9ef83", "name": "List inboxes", "request": { "name": "List inboxes", "description": { "content": "List inboxes.", "type": "text/plain" }, "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8309f75c-7d09-4b32-975b-1b371d502b54", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"inbox_address\": \"\",\n \"connected_email_address\": \"\",\n \"email_forwarding_enabled\": \"\",\n \"from_name\": \"\",\n \"default_status\": \"\",\n \"default_assignee\": \"\",\n \"signature\": \"\",\n \"auto_bcc_enabled\": \"\",\n \"auto_bcc\": \"\",\n \"auto_reply_enabled\": \"\",\n \"auto_reply_subject\": \"\",\n \"auto_reply_body\": \"\",\n \"off_hours_auto_reply_subject\": \"\",\n \"off_hours_auto_reply_body\": \"\",\n \"satisfaction_ratings_enabled\": \"\",\n \"satisfaction_ratings\": {},\n \"all_count\": \"\",\n \"mine_count\": \"\",\n \"assigned_count\": \"\",\n \"unassigned_count\": \"\",\n \"draft_count\": \"\",\n \"scheduled_count\": \"\",\n \"snoozed_count\": \"\",\n \"later_count\": \"\",\n \"spam_count\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"agents_conversations_count\": {},\n \"reply_as_alias\": \"\",\n \"insert_signature\": \"\",\n \"business_hour_enabled\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"inbox_address\": \"\",\n \"connected_email_address\": \"\",\n \"email_forwarding_enabled\": \"\",\n \"from_name\": \"\",\n \"default_status\": \"\",\n \"default_assignee\": \"\",\n \"signature\": \"\",\n \"auto_bcc_enabled\": \"\",\n \"auto_bcc\": \"\",\n \"auto_reply_enabled\": \"\",\n \"auto_reply_subject\": \"\",\n \"auto_reply_body\": \"\",\n \"off_hours_auto_reply_subject\": \"\",\n \"off_hours_auto_reply_body\": \"\",\n \"satisfaction_ratings_enabled\": \"\",\n \"satisfaction_ratings\": {},\n \"all_count\": \"\",\n \"mine_count\": \"\",\n \"assigned_count\": \"\",\n \"unassigned_count\": \"\",\n \"draft_count\": \"\",\n \"scheduled_count\": \"\",\n \"snoozed_count\": \"\",\n \"later_count\": \"\",\n \"spam_count\": \"\",\n \"teams\": [\n \"\",\n \"\"\n ],\n \"agents\": [\n \"\",\n \"\"\n ],\n \"agents_conversations_count\": {},\n \"reply_as_alias\": \"\",\n \"insert_signature\": \"\",\n \"business_hour_enabled\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6868575-f47d-4621-a13d-445e3df57377", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89350453-29f1-43d8-9bc0-672a796eb44f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e24b0a65-d3cb-44c2-ba14-f28800da904e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2ee7987-681b-470a-b83c-77d85018cec1", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfedcbfa-1a05-469e-b806-f29b34b91b8b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2936cf2d-fb05-43f5-a587-631b7d3fbe2a", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a5e1022c-eca7-4fd5-9c93-1e79fcea2236", "name": "List conversations in an inbox", "request": { "name": "List conversations in an inbox", "description": { "content": "List conversations in an inbox.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db70424b-6e19-4179-816f-a9f931bcd5e6", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Active\",\n \"is_spam\": \"\",\n \"priority\": \"Low\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n },\n {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Active\",\n \"is_spam\": \"\",\n \"priority\": \"Medium\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\",\n \"path\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4623844e-ebdd-425c-9f69-2a790965a8b0", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24d387cf-9189-4045-9ce2-2d3d885e6c6c", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff510d2c-4e62-4517-80b6-410d09e24db1", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99bcc7af-0feb-4a17-89b4-033294fecf44", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2f8346d-32a5-40cc-b0a3-915bfd608b7b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb9a2686-aa2f-4a71-9515-6c9532a8361b", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per-page", "value": "20" }, { "disabled": false, "description": { "content": "Custom view ID whose filters shape the list.", "type": "text/plain" }, "key": "view", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c24d56c-12cd-4e05-9627-aedbc92cef14", "name": "Filter conversations in an inbox", "request": { "name": "Filter conversations in an inbox", "description": { "content": "Filter conversations in an inbox.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "bbeadc00-3adb-4bdf-a8ca-b8decc772453", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Active\",\n \"is_spam\": \"\",\n \"priority\": \"Low\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n },\n {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Active\",\n \"is_spam\": \"\",\n \"priority\": \"Medium\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\",\n \"path\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3c4a361-7fcf-446f-943b-fae84638ea0d", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78fd391f-ae5e-4050-bb57-cf2e25d36bb6", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "366ad377-d4b8-45f6-b8cd-d24b6065fc4a", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0598043-eb04-4ce6-9550-a2d2961b12d0", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52f2c368-ac03-46a7-94eb-532ef5e4e59c", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c00fa202-de69-4040-8f3c-14b4c6277f7c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filters\": {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": true,\n \"key_1\": 551.4534662761272\n },\n {\n \"key_0\": 8411.99889804871\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"gt\",\n \"values\": null\n },\n {\n \"condition\": \"or\",\n \"groups\": [\n {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 1502.6966978849732\n }\n ],\n \"attribute\": \"\",\n \"comparison\": \"contains_exact\",\n \"values\": null\n }\n ]\n },\n \"display\": {\n \"sort\": \"oldest\",\n \"per_page\": \"\",\n \"page\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "34a08612-8498-4d20-b28d-b850a3a8cc87", "name": "List automations", "request": { "name": "List automations", "description": { "content": "List automations.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a9431c2e-9c6f-452b-9589-a115349c6d4a", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"automatic\": \"\",\n \"active\": \"\",\n \"when\": {\n \"key_0\": 7703\n },\n \"rules\": {\n \"key_0\": 8797.32420299038,\n \"key_1\": 736,\n \"key_2\": 4720.427714906797\n },\n \"actions\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": 9108.333347306221\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"Administrator\",\n \"presence\": \"away\",\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": 4779.852720391367\n },\n \"firebase_notification_preferences\": {\n \"key_0\": \"string\",\n \"key_1\": 9501\n },\n \"mobile_notification_preferences\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n },\n \"uses_count\": \"\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"automatic\": \"\",\n \"active\": \"\",\n \"when\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": false,\n \"key_3\": 1204,\n \"key_4\": 8045.645875945767\n },\n \"rules\": {\n \"key_0\": false\n },\n \"actions\": [\n {\n \"key_0\": 924.7785594127911,\n \"key_1\": 5891.795036947954\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"Administrator\",\n \"presence\": null,\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": \"string\"\n },\n \"firebase_notification_preferences\": {\n \"key_0\": 9670,\n \"key_1\": 8900.12509249738,\n \"key_2\": 1631.5655942328299\n },\n \"mobile_notification_preferences\": {\n \"key_0\": true,\n \"key_1\": 784\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n },\n \"uses_count\": \"\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e15ad5-1044-4ad1-a32b-f7905432e617", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89852eb-911d-424d-a407-2dbf775aa9dc", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75c26cab-5055-4450-80b6-0b6d766e1207", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fe49cd6-c67e-4514-ac70-c33cc66cf01c", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9d7a62e-9e4f-44c8-a470-745964b69921", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad2e64e3-e63b-4b19-9785-10d2622621ea", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e38203e7-adbf-4d72-a94e-36a96c361ac9", "name": "View an automation", "request": { "name": "View an automation", "description": { "content": "View an automation.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "automation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b1dae9cf-f3c5-4f08-acac-08230fa4f1e4", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"automatic\": \"\",\n \"active\": \"\",\n \"when\": {\n \"key_0\": false,\n \"key_1\": 4786.794449836127\n },\n \"rules\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": true\n },\n \"actions\": [\n {\n \"key_0\": \"string\",\n \"key_1\": 70.77573176525797\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"created_by\": {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"User\",\n \"presence\": \"online\",\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": \"string\"\n },\n \"firebase_notification_preferences\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": true\n },\n \"mobile_notification_preferences\": {\n \"key_0\": 2368,\n \"key_1\": 6971.035075075562,\n \"key_2\": 9764\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n },\n \"uses_count\": \"\",\n \"last_used_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1955d398-90ff-42d4-b62f-5f7e1ff25925", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e3badf7-0bd3-4cd4-ae02-573de83d757f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "642de7a0-898e-45ec-b827-a95fbc2590cf", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a52b8059-dc69-4901-b42e-3e28f0adbd1b", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0467247-aef4-44bf-a718-d72da0ee4e09", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ef4cdf-6924-4842-ba19-24422069af69", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2092eb3f-4caa-4f79-99c0-8307f125eadb", "name": "Delete an automation", "request": { "name": "Delete an automation", "description": { "content": "Requires the `delete_automations` permission. Permanent: the automation is removed outright, and conversations it already acted on keep those changes. Creating and updating automations is not part of this surface.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "automation_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "123e1ac3-c15a-4636-93d1-6b3c690ba019", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97659566-f534-4843-a69e-bd9ca173239e", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a97fc94-873c-430f-b609-d94fecd243c2", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031c84da-bcf2-4988-804b-ef7e00dbf15b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95f13088-af74-43e5-8413-309c8f97c8f5", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abb037c0-4813-47f9-a962-f598f8c63a2b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c2c6e2-f7e4-456d-a7ad-9389269d78a6", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "automations", ":automation_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "automation_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "35acaaed-c3e1-4151-b286-4b6cdd6ad2d1", "name": "Soft-delete many conversations", "request": { "name": "Soft-delete many conversations", "description": { "content": "Soft-delete many conversations.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "29eacb0b-9f33-4bb5-b035-39f788baea2e", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d65108e8-4980-4cb5-9957-1a8337e1edc5", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55061555-5959-419a-a85a-48db5ea5025e", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70ce6a73-d574-487f-b470-673798700159", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d651d6e-6a0e-4900-b461-a0a31b943abe", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e77ae76e-5789-4381-9f89-5b1fc38a2a6a", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6d29d4d-b09e-42d6-abcc-2ba30df43af6", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "550f0728-0687-477d-8847-6b3163b8acf4", "name": "Restore many trashed conversations", "request": { "name": "Restore many trashed conversations", "description": { "content": "Restore many trashed conversations.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ebd4c1ab-dbcd-45fa-b483-d29c09dac67b", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d38607c-6a9f-4cb4-b41a-0f3e1550976f", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9466580e-1fff-4f3b-acba-cf93722174a6", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e835b943-1c86-4d25-a044-b1310ca7e861", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d090847e-65a8-4e53-ac1a-aaba5d332bab", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9381da5d-08c7-48ee-8938-12736a9def75", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43d840a1-7911-488a-b9aa-63175e02117e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversation_ids\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bd2f4513-1989-412f-8849-3b2b441d91c3", "name": "Bulk update conversations", "request": { "name": "Bulk update conversations", "description": { "content": "Bulk update conversations.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "177ad95c-ce78-4795-9b3a-6498fc0c65b9", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc0b02b5-a70e-4252-bd2d-663f876f909b", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6bd96aa-a134-4982-8a6b-aec022d0703b", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c4ebd96-8258-4140-91ef-f91cb3866a7e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3e122dc-1b07-47d0-aa93-ee7a5867b222", "name": "No update field was provided.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2c33bee-fb2f-4974-bbb8-50a7001f455d", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fd8a540-86ad-4888-8614-399216601ad1", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3aac41ad-91a3-4d36-9987-cbed9f2c45b7", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "batch", "update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"conversations\": [\n \"\"\n ],\n \"status\": \"Processing\",\n \"is_spam\": \"\",\n \"assign_to\": \"\",\n \"tag\": \"\",\n \"priority\": \"Medium\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49c23882-9ae2-4900-9fa4-d828666c8cd8", "name": "Start a new conversation in an inbox", "request": { "name": "Start a new conversation in an inbox", "description": { "content": "Start a new conversation in an inbox.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "fe8c37fa-f27e-4b15-a0e7-4083f2ddb861", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e75c26b6-fa4d-4cee-9cdf-87edcd36fb6b", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1323ba48-efc8-4bf3-9aef-bf802351e0cf", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ab25412-9a5d-46ff-aa93-cb53a334c44c", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c2a375d-4661-4c91-94f8-381dcc5b1877", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cff4ed65-19e6-48ce-947d-703251c6d492", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37445e89-ddd4-405a-9eac-3f189cf4b0d4", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"status\": \"Closed\",\n \"subject\": \"\",\n \"message\": \"\",\n \"cc\": [\n \"\",\n \"\"\n ],\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"agent\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"is_draft\": \"\",\n \"message_id\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"contact\": null,\n \"custom_fields\": {\n \"key_0\": \"string\",\n \"key_1\": 1608.9282051837638\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ed0078e-57b2-4dbc-8a25-a22f337ba5fc", "name": "Create a custom field", "request": { "name": "Create a custom field", "description": { "content": "Create a custom field.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8f5b2841-257e-4390-be13-1c71f941a19f", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"number\",\n \"default_value\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"order\": \"\",\n \"extra\": null,\n \"options\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"key_0\": 9056,\n \"key_1\": 4144.839200439965\n },\n {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": false\n }\n ],\n \"created_at\": \"\",\n \"readable_created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "867cb866-1280-49af-bfd6-d550fb81e520", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9806801-949c-477a-9560-cbaadc629330", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbf263e2-d207-49b7-8fa0-1c9ed3882c30", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82c8ca1e-7e63-43fc-985d-c537a62bcf69", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86f9b8c1-215b-469c-a022-d12fe54ff1b6", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15df966b-2bdf-495e-b8aa-75d8b6582fe3", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"type\": \"dropdown\",\n \"key\": \"eIkE1S\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n \"\"\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "83474928-adb7-4870-b18f-9a5928333629", "name": "Update a custom field", "request": { "name": "Update a custom field", "description": { "content": "Update a custom field.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "field_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a97133ab-f2ba-47a6-95ee-5619f0b31a04", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"data\": {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"name\": \"\",\n \"key\": \"\",\n \"description\": \"\",\n \"type\": \"number\",\n \"default_value\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"order\": \"\",\n \"extra\": null,\n \"options\": [\n {\n \"id\": \"\",\n \"value\": \"\"\n },\n {\n \"id\": \"\",\n \"value\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"key_0\": 9056,\n \"key_1\": 4144.839200439965\n },\n {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": false\n }\n ],\n \"created_at\": \"\",\n \"readable_created_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061b658b-afbc-41a2-b3ca-9e76e28c2368", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "173cf34a-7dad-45ce-87d0-daada28a4838", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5c559d1-a5fd-4cc9-b9cf-fe2b85b1d5f4", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e63f6c82-4935-447e-929d-951fc19866f9", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8246e97b-c5ec-410c-bea5-558d239738c5", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "886a5f2e-4db1-40b2-9f3b-6bdbb02a1b2e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_active\": \"\",\n \"default_value\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"id\": \"\"\n },\n {\n \"value\": \"\",\n \"id\": \"\"\n }\n ],\n \"conditions\": [\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n },\n {\n \"expected_value\": \"\",\n \"dependent_field_ids\": [\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02b7284a-60c1-4a4a-9abf-46c7db7d25dc", "name": "Delete a custom field", "request": { "name": "Delete a custom field", "description": { "content": "Delete a custom field.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "field_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "10c9a748-2b54-453a-bcd0-b38c13d6179a", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5e8c429-e802-4a41-a8cf-fd38dce2c312", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ca5d2c8-c829-4379-b8dd-1b875578a6f0", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "653c1713-729e-4c36-8f71-59794589119a", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d55ec6a-e412-475f-982b-3fe1c9b13cc2", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f324aa3-57c4-4f6d-a41d-1727a906a488", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8db53d18-6ef2-4bdb-b7d1-4aec2417a16c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-fields", ":field_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "field_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "04a762a4-d857-4ed7-94d7-d40576d9d9df", "name": "Delete a custom view", "request": { "name": "Delete a custom view", "description": { "content": "Only the teammate who owns the view may delete it, the account owner included. Permanent, and it removes the view for everyone it was shared with. Listing and creating custom views is not part of this surface, so the identifier has to come from a first-party client.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "custom_view_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "96e13d24-1b08-439f-a61f-6891ab9488e0", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ee72129-39e8-43c6-8605-be326a1ba0ee", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b11da247-d58f-4e4d-ae9a-1311ee40b9b1", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "005be211-2652-4ff2-83cd-15e63933ee4c", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8092d07-1f6b-405c-bf74-711bf41e0b4e", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db226038-8212-41fe-9680-18007f08c499", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16b43265-6975-4db7-8d01-217c6017949a", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "custom-views", ":custom_view_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "custom_view_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bafca057-aa67-4db9-90eb-4e576364dfa5", "name": "List saved replies for an inbox", "request": { "name": "List saved replies for an inbox", "description": { "content": "List saved replies for an inbox.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "641832aa-71a0-45b6-8554-33e05743ecf0", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\",\n \"uses_count\": \"\",\n \"author\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\",\n \"uses_count\": \"\",\n \"author\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d02fec4-6871-4e13-b6d4-67e6c84eb333", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b95fb578-ce1b-47ac-8699-ce16f9edc8a0", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85227d1a-f0a9-4276-9419-849ba4621edf", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b864eea-acce-42c0-8b94-bc62ef6f3d6a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23a4a35d-c99a-4e28-bf42-eacad29f3088", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5e22a02-455f-4818-9082-18d95fb4d1b6", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2cf712ff-aa68-4a3c-a865-762fe806592c", "name": "List tags assigned in an inbox", "request": { "name": "List tags assigned in an inbox", "description": { "content": "List tags assigned in an inbox.", "type": "text/plain" }, "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "aa385995-716e-4fe9-8d7d-fa77822e7f62", "name": "Success.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#eDc38d\",\n \"conversations_count\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#79C299\",\n \"conversations_count\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"current_page_url\": \"\",\n \"from\": \"\",\n \"to\": \"\",\n \"per_page\": \"\",\n \"path\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9d244dd-8752-4d10-ad9e-373cca1c5beb", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d337b128-f20c-4c22-adfb-96f0582f2ccd", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15fe3f4d-d524-4ccb-a6ac-ad7f16e7cc30", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3109450-932c-427d-89db-429a55e4077b", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658d755d-0387-458a-809a-bebb47f60539", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09fe40b8-e907-42df-ba13-98dbc8976e83", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "inboxes", ":inbox_id", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Tags", "description": "Conversation labels, organized per organization.", "item": [ { "id": "f0819bc4-8d01-4225-94da-c1b9d84d0790", "name": "List tags", "request": { "name": "List tags", "description": { "content": "List tags.", "type": "text/plain" }, "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "84009f17-33ce-42f7-bf78-3d29d0b7e4d1", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#bB0EcE\",\n \"conversations_count\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#bFA0f2\",\n \"conversations_count\": \"\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\",\n \"path\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a15ee7e0-a027-4068-9d76-7baf15bdd39a", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bb691fc-ef3f-49a5-96ff-1ea138aa7ceb", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d806ffe-d618-4540-9863-8ba85f04bd84", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad6a694a-3f47-48d8-912b-454b218fcef1", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a254b764-694e-48ac-9cfa-6779234aab8e", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea216aa-b4b3-4ff1-b51a-38280b670fbd", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "per_page", "value": "15" }, { "disabled": false, "description": { "content": "Search tags by name.", "type": "text/plain" }, "key": "q", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d1c9dac-4de8-4733-b8ef-8c5bed9b93ef", "name": "Create a tag", "request": { "name": "Create a tag", "description": { "content": "Create a tag.", "type": "text/plain" }, "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d5e07307-9c61-4efc-b2ad-6d6db3307f0c", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"tag\": {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"#0EBB4c\",\n \"conversations_count\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c57a966d-e0f0-4a66-87ca-237d59b803d9", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48936dd8-4bc6-4376-a724-b70c2d238d72", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "242d85eb-f0d9-4fe0-a20b-ff1ed27eed90", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cc6ec4b-2231-4ed7-b4a5-79ea79ac6cdb", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d6cfae-5e95-4679-a3f5-bf438e8cba74", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "485f3cb7-fa2d-4d56-8796-916f7b9997bb", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "tags" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"#dAa1E9\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1bf87fd6-e53e-42f5-914b-eb4bdc9cdb97", "name": "Update a tag", "request": { "name": "Update a tag", "description": { "content": "Update a tag.", "type": "text/plain" }, "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tag_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "97d018de-977e-4f13-bee5-bce94473767e", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98355658-8276-478d-8e60-54aad069661d", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "039a7fc7-5cc5-41f3-8dbd-21f6fcea6493", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b38941d-138f-41db-b12d-1ee1230433d8", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fdf06301-f1bf-49cd-ab13-da989125b95b", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0227f01c-f2a0-4e18-91b2-5699035b26cc", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6c0fa86-bd4f-4a08-9b8f-cdf12397f480", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"color\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bfbe57ab-22ee-448b-879d-b44439c6c6e1", "name": "Delete a tag", "request": { "name": "Delete a tag", "description": { "content": "Delete a tag.", "type": "text/plain" }, "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "tag_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "61e2c60b-05ea-4b8b-b62a-4f2b7c8bf437", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f244d522-a56f-4426-8bdd-dcf77765d2c9", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1cfaeb1-d0a0-4b08-bbee-071d650c72cd", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67c4bc52-fdad-4dc7-bbaa-98afa6800fe4", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12940583-addf-453a-a0a1-51da25be0277", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d55d88e-e395-4a40-9b3a-e9632e646590", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07172979-a340-4cf8-b46c-c117483736a1", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "tags", ":tag_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "tag_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ac56b14-1fe3-4da8-8e44-36b523acf972", "name": "Merge tags into one", "request": { "name": "Merge tags into one", "description": { "content": "Merge tags into one.", "type": "text/plain" }, "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b5c85f4e-1f85-4fa5-a7af-78094ebdced9", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236191a9-7647-403f-89b0-5ef2bcc4d00d", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0b24175-9439-46fd-9fad-7729f8c0e0ac", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67f3c04c-9d31-437c-9852-234bc1b5cc4f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc631338-ccf4-4296-baef-25c0e802580a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02c9c31e-ccde-4c14-b4b7-99a52722534f", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d090d11-2c36-41bc-9a29-dc41970b16c9", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "tags", "merge" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"color\": \"#C5094A\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Users", "description": "Teammates (agents, admins, owners) and their pending invitations.", "item": [ { "id": "b800dcaf-ee9a-4a75-9f3d-c6aba6eb81a9", "name": "List teammates and pending invitations", "request": { "name": "List teammates and pending invitations", "description": { "content": "List teammates and pending invitations.", "type": "text/plain" }, "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2deb3f63-4579-4708-83d7-06ce747b3491", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"Account Owner\",\n \"presence\": null,\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": false\n },\n \"firebase_notification_preferences\": {\n \"key_0\": true,\n \"key_1\": false\n },\n \"mobile_notification_preferences\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": 2956\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"Administrator\",\n \"presence\": null,\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": \"string\"\n },\n \"firebase_notification_preferences\": {\n \"key_0\": 5710,\n \"key_1\": true,\n \"key_2\": true\n },\n \"mobile_notification_preferences\": {\n \"key_0\": \"string\",\n \"key_1\": false,\n \"key_2\": false,\n \"key_3\": 6707.07421781228\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n }\n ],\n \"invitations\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"role\": \"Administrator\",\n \"accept_url\": \"\",\n \"decline_url\": \"\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"role\": \"User\",\n \"accept_url\": \"\",\n \"decline_url\": \"\",\n \"created_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "001d5057-bcfe-4912-a3ef-607be46de626", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8367345b-2b37-4ffb-9851-76c8bccc2709", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14c99b3f-4a75-4c72-a3cc-1a2a8d348201", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64e9f72d-88fa-46d2-b3cd-199dcdf7ea0a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b58ccf-a2b4-4e79-bb56-9335573b229b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "219a24e0-43a4-47f7-8c36-04487e749642", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "31c0a6b8-222e-49fd-ace7-f477a36d7a36", "name": "View a teammate", "request": { "name": "View a teammate", "description": { "content": "View a teammate.", "type": "text/plain" }, "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "user_id", "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d22ca9de-f6a1-4515-9987-fe95a001190e", "name": "Success.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"Administrator\",\n \"presence\": \"online\",\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": 2414,\n \"key_1\": 1439.8165328644475,\n \"key_2\": 1343.6168075700782\n },\n \"firebase_notification_preferences\": {\n \"key_0\": 4514.098604831726\n },\n \"mobile_notification_preferences\": {\n \"key_0\": 9922.803060807104\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00a4fadc-9a4a-4829-b66a-c5723364588c", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d495424-3740-4c50-b6db-d3ee0cdae730", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0a798ec-a260-4afd-a536-189c373ce171", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dc82994-a7e4-4b29-93e7-8dd1c4d881b2", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e0f6aed-2639-4861-a0ec-76816f25f0bc", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08ea7bfb-f62c-4307-b347-b43026382ba9", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "settings", "users", ":user_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Teammate identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "user_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Saved Replies", "description": "Templated replies agents can apply to conversations.", "item": [ { "id": "6dc0a3c6-6031-4869-898d-a8d5c4a70c4f", "name": "List saved replies", "request": { "name": "List saved replies", "description": { "content": "List saved replies.", "type": "text/plain" }, "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "68b90b0e-c3ec-4a38-9fa9-ba3a7628dc33", "name": "Success.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\",\n \"uses_count\": \"\",\n \"author\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\",\n \"uses_count\": \"\",\n \"author\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\"\n },\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd8cb2be-1a2b-4a8e-adb5-ce3d8fe8d65e", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1013552f-826b-44ac-8e6c-ac132491c965", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5602681a-0bde-47b5-b505-ffe972df5d2e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e2d98ed-2635-4722-945b-df7bc310fb53", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "766e3d35-d0e8-44ba-a43d-caab431a951d", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbc02403-fb34-4c05-8365-d55208ea9be5", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Inbox to list saved replies for. Pass \"all\" for every inbox plus global replies.", "type": "text/plain" }, "key": "inbox_id", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6a7c85c-6e2e-48b1-9782-a3308561c156", "name": "Create a saved reply", "request": { "name": "Create a saved reply", "description": { "content": "Create a saved reply.", "type": "text/plain" }, "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e29e98d-b987-47af-a15c-361b8c89177f", "name": "Success.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "428219fb-4ee2-4657-9237-9130b48eaac0", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "308349fc-3b54-47db-858b-c166f202abd7", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69bc95cf-50f1-4da1-aac0-18cfc2f7ae8b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88a18457-9e6d-4d81-b478-582d1db97ec6", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13c4e635-c149-4329-8518-6e264c8151a7", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8483aa48-2ca7-4bef-ab4f-067fa1f07922", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "saved-replies" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62282762-23c6-46f2-9df4-e1cf1ea9b6a1", "name": "Update a saved reply", "request": { "name": "Update a saved reply", "description": { "content": "Update a saved reply.", "type": "text/plain" }, "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "saved_reply_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cdc90527-55d6-4a6c-94c8-250411dbe00e", "name": "Success.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526229db-fac1-462b-98ee-9179ce0b962e", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bd3f3ed-1def-4e0a-a4e1-e7143f576ce6", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdeffed1-824a-49db-99dd-d1c3220918c2", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3078077-798f-4310-8ccb-017dcf232338", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da7bb0dc-4552-49d6-98a9-b9c313242eba", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "517f632a-1e49-42fe-b267-7a007887aa10", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"message\": \"\",\n \"folder\": \"\",\n \"inbox_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "196b4a72-1803-4fe6-ae14-1c28d787f9ff", "name": "Delete a saved reply", "request": { "name": "Delete a saved reply", "description": { "content": "Delete a saved reply.", "type": "text/plain" }, "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "saved_reply_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6cff99f1-2b79-4bf5-a0ac-a6eda4361261", "name": "Success.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c7ccd1f-c70e-4a93-8175-968f03b0692e", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae81671c-8d76-4dac-9057-3c531ddf3e4d", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60d28d41-f900-4edb-9c09-7a8925746042", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b7caa2e-0342-4d6a-bf70-5f6f46834b96", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9703fdc3-73cb-438d-ba44-281a21bdaf24", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a77486a-5bbc-4485-bddc-2b269eb2d9f4", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "saved-replies", ":saved_reply_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "saved_reply_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Business Hours", "description": "Operating-hours profiles and the inbox channels they cover.", "item": [ { "id": "7d96b9c6-2da1-4c7d-800f-d2a3eb7e4bfa", "name": "List business-hours profiles", "request": { "name": "List business-hours profiles", "description": { "content": "List business-hours profiles.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8bb809b1-8de7-4045-8a9c-c326fc1ec664", "name": "Success.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"calendar_24_7\",\n \"schedule_type\": \"custom\",\n \"schedule\": null,\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"livechat\",\n \"email\"\n ]\n },\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"livechat\",\n \"livechat\"\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"calendar_24_7\",\n \"schedule_type\": null,\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n },\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"livechat\",\n \"email\"\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e22ddc9-6c4f-4e62-9e5b-5ea547df32e8", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "445010d1-3206-498e-b245-75346dc3f585", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ba14663-d2fa-4584-a034-25ab4dffad7a", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "765826de-7e06-4fd8-bcb1-328bdeb1affa", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60d9ae43-179b-4eba-80e9-1282277f357d", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec39cd7-10bf-4271-a14f-3ebd3ee5e893", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f900b135-9a74-4586-a70c-d31eac49834a", "name": "Create a business-hours profile", "request": { "name": "Create a business-hours profile", "description": { "content": "Administrators and the account owner only.\n\nAn inbox channel belongs to at most one profile. Binding one that another profile already covers returns 422 carrying `conflicting_business_hour_id`, `inbox_id`, and `channel` in place of the usual `errors` object, and the whole write is rolled back.\n\nUnder `calendar_24_7` the server stores `schedule` and `schedule_type` as null whatever the payload carries.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "25cfee8d-e324-4517-8b03-d2a4d5d37457", "name": "Success.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"calendar_24_7\",\n \"schedule_type\": null,\n \"schedule\": null,\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n },\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "181beec2-9afc-4e06-9666-278a712bb705", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c89cca86-4de7-4586-8646-6f5f427c5597", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c108ff6f-460d-477c-b275-de05634484c7", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd2b4e97-abb1-4a79-a567-e67b692d0b5a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1a57481-3655-4ba4-91e5-f1c1c2449690", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1d856b8-95cf-4273-bd5b-43b7ce6d7e09", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "business-hours" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"mode\": \"business_hours\",\n \"description\": \"\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4f161807-8978-4d6e-8ff0-a03669a3b1ee", "name": "View a business-hours profile", "request": { "name": "View a business-hours profile", "description": { "content": "View a business-hours profile.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "business_hour", "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "306f1a8f-4bd5-42b9-8689-40985a2615aa", "name": "Success.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"calendar_24_7\",\n \"schedule_type\": null,\n \"schedule\": null,\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n },\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c916af6c-1f20-4d4e-8cf5-7f323543ff40", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5915dc0-96f5-489e-a0f3-c86375e4212f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f1cf3b2-c918-45a2-a4dc-71f7b6823c69", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f354c3-2ae8-43bb-b594-d90a85b512a7", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03ead11a-ee84-4426-92bc-36e7412661fd", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e05ad9ad-a20d-4c9f-9d8d-b749556a4d63", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73467e4d-541d-4215-9689-4aa1e10bdd4f", "name": "Update a business-hours profile", "request": { "name": "Update a business-hours profile", "description": { "content": "Administrators and the account owner only.\n\nAn inbox channel belongs to at most one profile. Binding one that another profile already covers returns 422 carrying `conflicting_business_hour_id`, `inbox_id`, and `channel` in place of the usual `errors` object, and the whole write is rolled back.\n\nUnder `calendar_24_7` the server stores `schedule` and `schedule_type` as null whatever the payload carries.\n\nOmitted keys keep their stored value and an explicit `null` is ignored rather than clearing the field. Sending `inbox_channels` replaces the whole set.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "business_hour", "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1c9af308-63db-436a-9f15-3a956ce2b77d", "name": "Success.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"calendar_24_7\",\n \"schedule_type\": null,\n \"schedule\": null,\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n },\n {\n \"inbox_id\": \"\",\n \"channels\": [\n \"email\",\n \"livechat\"\n ]\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "572c50d4-e842-4588-8e63-f18368b05330", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfb45a7-55ed-4e6a-8788-ec16058e7390", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "012f4602-dec0-4019-af28-3ca97d9cfcac", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e80ad5f7-6f4d-4ccf-9299-7fb33d1dffaa", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d32865d9-0b78-4a48-9966-adf382891db6", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e4f8d76-1890-4936-ac68-2d2b0032989e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"mode\": \"business_hours\",\n \"schedule_type\": \"custom\",\n \"schedule\": [\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"fri\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"thu\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"sun\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"mon\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"tue\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"day\": \"wed\",\n \"enabled\": \"\",\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"inbox_channels\": [\n {\n \"inbox_id\": \"\",\n \"channel\": \"livechat\"\n },\n {\n \"inbox_id\": \"\",\n \"channel\": \"email\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72d7a2f5-6cbd-43b5-86fa-b78b385f938b", "name": "Delete a business-hours profile", "request": { "name": "Delete a business-hours profile", "description": { "content": "Administrators and the account owner only. Permanent, and it releases every inbox channel the profile covered.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "business_hour", "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "af9aea74-0d49-4262-b9bd-1e99f761386b", "name": "Deleted. Empty body.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "17f56bd5-b81b-42b8-a3da-c55ffb5bddfd", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fe20aaa-e9b2-45d1-98e5-590f5d0a95ad", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49cbc090-2e50-415d-857c-7ef4c6d21148", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b488b84a-d343-4b9e-a844-325a6f1aae62", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "986d1a58-f870-4640-8952-1d42fd9477bb", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ef94c4a-6f5e-4a86-92c2-ec592551062e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "business-hours", ":business_hour" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Business-hours profile identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "business_hour" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Holidays", "description": "Dated closures that suspend business hours.", "item": [ { "id": "86285782-9ff5-4250-bc1d-79398f28710e", "name": "List holidays", "request": { "name": "List holidays", "description": { "content": "List holidays.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "da75827c-327f-4e1a-9a3f-34d9fd279a0f", "name": "Success.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"status\": \"active\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"status\": \"upcoming\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4f33b4e-17b5-4df3-9d02-ebd9125c901e", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a9a52f-6ad0-45f3-94bf-dd0d847d4187", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "614453ff-e2c2-45d0-bfe4-119c20909015", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75251c48-452d-4623-84cf-e6b875c9ad77", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "284dfb9a-ada3-41ec-ae05-88cf27da01f9", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1447677-56b8-40d8-8afb-f5626fedebcf", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7c936bf-c6cd-4502-951c-f1b0fb97b533", "name": "Create a holiday", "request": { "name": "Create a holiday", "description": { "content": "Administrators and the account owner only. Ranges may overlap an existing holiday.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "51a62156-0a24-4cb8-858d-7f6184e301cf", "name": "Success.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"status\": \"past\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ad6f28-e325-49a7-a520-f01913d0aab3", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d161411-4cb8-4ba5-9374-a29fe82f7497", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "441dd7c7-cda4-4b1a-8638-a4ede63f6b41", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6ab3f27-1244-4c5e-bea1-7a3842d0f250", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "75afd187-c625-4205-9c74-738a65be5379", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e8e4007-fcc4-483e-92e5-45ed5d34571c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "holidays" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a6ee3bc3-b995-473b-8eb2-92c36d03ab72", "name": "View a holiday", "request": { "name": "View a holiday", "description": { "content": "View a holiday.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "holiday", "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "345bc8c4-f7ec-46a4-a655-179312b5a828", "name": "Success.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"status\": \"past\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f574a98c-01b1-4f9f-a0df-3cbe83e45e88", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a68f8976-0356-4c64-827e-128acdd8a5f1", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dde99f35-6432-48dc-a99b-3bc77ad4b95e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fafc43fe-441a-49af-8ee3-94e3a6db041c", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57c046e9-3493-4ea6-a951-de450611d5ee", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "040d8fba-0535-4ee4-be88-01559eefddd0", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "db1c1c2f-8001-4d8e-b878-48783829bc3c", "name": "Update a holiday", "request": { "name": "Update a holiday", "description": { "content": "Administrators and the account owner only.\n\nWhen only one date is sent the range is checked against the stored value for the other. A range violation is always reported under `end_date`, even when `start_date` is the field that moved.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "holiday", "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0cb5237e-fd54-4111-9e2d-36ce013e599f", "name": "Success.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"status\": \"past\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8de8f1e-cf5f-4d92-9942-4917f767fb30", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7b5ce7e-5d75-4544-8c9d-170b41b9ebbc", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d66dfbc-2cba-4870-bdc0-1f6a6c443f28", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bef4efb3-409a-49f6-b2ef-c9ce5ca1ed97", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f3d785a-3519-47dc-b94a-0601d93e5d71", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28b354d4-40d3-4365-9677-0e393ef2599f", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"start_date\": \"\",\n \"end_date\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "998a8f96-0dba-431d-a4f9-7ac6a4d3f089", "name": "Delete a holiday", "request": { "name": "Delete a holiday", "description": { "content": "Administrators and the account owner only. The holiday stops applying immediately and drops out of the list.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "holiday", "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0ff14e17-9062-464a-b02d-950b30964de9", "name": "Deleted. Empty body.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0179883c-2433-480e-a8a2-b3576e0e1f42", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b1a4b26-1be1-4d73-8364-07ec107dae34", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "150da3a2-8186-48db-bda9-3da07701f64d", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77570c5c-c1a2-45bf-a48b-c98782741102", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b478e85-12cb-4041-a26a-b980ae316614", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "964d062a-5ecb-4a75-b51a-9063073a13b9", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "holidays", ":holiday" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Holiday identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "holiday" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Reports", "description": "Aggregate metrics for conversations, happiness, productivity, ratings, and agent performance.", "item": [ { "id": "abc65975-b9a1-434b-987e-db8afb8badd2", "name": "Agent leaderboard", "request": { "name": "Agent leaderboard", "description": { "content": "Agent leaderboard.", "type": "text/plain" }, "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dca4d41f-9d8b-4f36-acf5-a8a3fc49f2df", "name": "Success.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"agents\": [\n {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"conversation_count\": \"\",\n \"resolution_count\": \"\",\n \"pivot\": {}\n },\n {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"conversation_count\": \"\",\n \"resolution_count\": \"\",\n \"pivot\": {}\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "826e877a-9400-4b78-b6ef-e15119a9e838", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c103443-668c-406f-aa48-1a78576a7e69", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36815759-4133-4402-8a87-cdf04066d45d", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27a1dc6a-3d1c-4082-87eb-0f3c1eadc026", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f32533cb-ecb8-42ae-960b-eaca1b9d0467", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a1330b8-2104-4479-9c1b-5c84f07bdce1", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "agents" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "41d3b723-c182-4f5f-b647-96a95bb69632", "name": "Conversation volume report", "request": { "name": "Conversation volume report", "description": { "content": "Conversation volume report.", "type": "text/plain" }, "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "99e349d3-a8fc-422f-8403-6dd2cb358add", "name": "Success.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total_conversations\": \"\",\n \"new_conversations_count\": \"\",\n \"new_conversations\": [\n {\n \"count\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n {\n \"count\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n ],\n \"resolutions_count\": \"\",\n \"resolutions\": [\n {\n \"count\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n {\n \"count\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n ],\n \"contacts_helped_count\": \"\",\n \"contacts_helped\": [\n {\n \"count\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n },\n {\n \"count\": \"\",\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\"\n }\n ],\n \"inbox\": {\n \"id\": \"\",\n \"name\": \"\",\n \"inbox_address\": \"\",\n \"connected_email_address\": \"\",\n \"email_forwarding_enabled\": \"\",\n \"from_name\": \"\",\n \"default_status\": \"\",\n \"default_assignee\": \"\",\n \"signature\": \"\",\n \"auto_bcc_enabled\": \"\",\n \"auto_bcc\": \"\",\n \"auto_reply_enabled\": \"\",\n \"auto_reply_subject\": \"\",\n \"auto_reply_body\": \"\",\n \"off_hours_auto_reply_subject\": \"\",\n \"off_hours_auto_reply_body\": \"\",\n \"satisfaction_ratings_enabled\": \"\",\n \"satisfaction_ratings\": {},\n \"extra\": {},\n \"organization_id\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reply_as_alias\": \"\",\n \"insert_signature\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22f8101d-97d7-45bb-9536-9e43669c1560", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "24e10514-21e0-4113-be0c-afb5e05da1d4", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea82eff5-2ebd-4545-a6c4-0f05729f8209", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f03435e-5174-472e-9098-07d1693591bb", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1771208-c24b-4469-abd8-92ee546d77bf", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ed9c815-31a7-4820-809a-7cc83d01d1c4", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "conversations" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "047b5c45-17ab-410c-8f74-676c0d5ed9ac", "name": "Happiness ratings report", "request": { "name": "Happiness ratings report", "description": { "content": "Happiness ratings report.", "type": "text/plain" }, "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "48d6b8b5-1d7f-443c-a2f4-132c9db6a6a6", "name": "Success.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total_ratings_count\": \"\",\n \"great_ratings_count\": \"\",\n \"bad_ratings_count\": \"\",\n \"okay_ratings_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b272880-b39d-4caf-b00d-6b7c6db23f28", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb40bd9e-efcf-4be4-9816-4b96968cdfbe", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b552c971-d995-4867-84a1-496e21b8c444", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57ebe637-2553-4c44-b9d3-5bbeecae03d4", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "588c8f7d-438f-4746-a825-c80568a08874", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e33d0d9-71b0-4679-b6da-837e8b52933e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "happiness" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "49da63fb-9c41-42fe-a231-c62139d1b215", "name": "Productivity report", "request": { "name": "Productivity report", "description": { "content": "Productivity report.", "type": "text/plain" }, "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "inbox_id", "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a5899567-42ef-4ea6-8c63-f8dcb8f741f3", "name": "Success.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"resolved_conversations_with_multiple_reply\": \"\",\n \"resolved_conversations_with_one_reply\": \"\",\n \"assigned_conversations\": \"\",\n \"created_conversations\": \"\",\n \"conversations_with_responses\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"messages\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"conversation_id\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"messages\": [\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"id\": \"\",\n \"created_at\": \"\",\n \"conversation_id\": \"\"\n }\n ]\n }\n ],\n \"resolutions_with_time\": [\n {\n \"date\": \"\",\n \"resolution_time\": \"\"\n },\n {\n \"date\": \"\",\n \"resolution_time\": \"\"\n }\n ],\n \"avg_replies_to_resolution\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f938af8e-9138-4d29-8074-2ca3a07e44c4", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e5ac5e-3220-42b0-8313-cec12c40cad9", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c9e7b7b-f4fc-42e2-a30b-3542689f4456", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bf7730d-be9e-4241-859f-75a01cef68f7", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e55dfeed-4554-4730-8632-d0134514d2d8", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d338c1ce-7071-4f68-bd27-8a2bfa863d4e", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "reports", ":inbox_id", "productivity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Start of the reporting window.", "type": "text/plain" }, "key": "start_date", "value": "" }, { "disabled": false, "description": { "content": "(Required) End of the reporting window.", "type": "text/plain" }, "key": "end_date", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Inbox identifier.", "type": "text/plain" }, "type": "any", "value": "", "key": "inbox_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Knowledge Base", "description": "Public help centers, their articles, and member access.", "item": [ { "id": "c9618833-706a-4d74-8770-fe417f3e6571", "name": "List knowledge bases", "request": { "name": "List knowledge bases", "description": { "content": "List knowledge bases.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "85b4c0fe-f1a5-41d3-8dcb-ace04256a771", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"visibility\": \"\",\n \"extra\": null\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"visibility\": \"\",\n \"extra\": null\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "549f639b-1d8f-472c-ba76-15d03d150aca", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5babbf53-b5f8-42f4-9f5c-9fe892ed6c09", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa259a10-9c08-4ab8-8434-de9a79731f97", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bd2141f-d817-4827-b018-c58a2a9c756d", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b6600e1-6687-4629-9c98-677ecd4d15ac", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d626cabb-51cf-4be2-9ca9-3370fa308d81", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78eceed0-6478-43f9-9340-d60f6f057149", "name": "Create a knowledge base", "request": { "name": "Create a knowledge base", "description": { "content": "Create a knowledge base.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b8f3a6e2-a4ad-4dd6-82cc-5f2d051fdf7d", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"knowledgebase_id\": \"\",\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0aca9ce-862b-4feb-a27b-88e4f663f1a8", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3362e93-2d6f-45fb-9596-01568a2a11ef", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19188382-04f4-44a5-a2fe-1e2ea897a981", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec37c157-2476-4db5-b24b-2e3ddafee26b", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5963d5ea-6e9f-4b3f-b815-fa39f6cc9e78", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236c2ff6-cdcc-494f-8f1a-3d4921df5022", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"is_private\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48321589-31a4-415f-af17-be4247caa218", "name": "View a knowledge base", "request": { "name": "View a knowledge base", "description": { "content": "View a knowledge base.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "knowledgebase_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b998ad8f-3582-4753-9838-5b4e13fe26bd", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"visibility\": \"\",\n \"extra\": null\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ba4c62-8251-4b19-813a-933cb6b029f8", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d62ed3a1-7b5c-42cd-bb97-7a2c0855a5c6", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "697b7b15-9f38-4375-8ce1-cc9ab2799332", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "850d4400-e87d-4637-adf3-89c75628a71d", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "227e4519-be77-4db0-8dfa-eeadcff77872", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "777a68ab-bb58-4246-a92e-d88d559ee775", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c0c8cad0-880a-48fe-b383-7ed7fb106310", "name": "Update a knowledge base", "request": { "name": "Update a knowledge base", "description": { "content": "Update a knowledge base.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "knowledgebase_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "716291c5-8691-444c-9fc9-42879e44b1c7", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff675822-866c-4396-8800-e44b3da166dd", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4a76236-3fab-4bb9-909c-e3ca85635ff3", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a30cfc14-bb2a-4fae-a86a-a4a9e52b621a", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2595cf87-33bd-4905-85da-62b0ab515238", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "10266ba8-a164-40be-a84d-8c885ba150bc", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "678afa50-c876-48d6-bb90-dff3bc2b1da5", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"slug\": \"\",\n \"members\": [\n {\n \"email\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"role\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ee8900fa-f3b3-4128-a335-19afbd71ef24", "name": "Delete a knowledge base", "request": { "name": "Delete a knowledge base", "description": { "content": "Delete a knowledge base.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "knowledgebase_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ac14aff1-9f47-4a70-9f8d-0299736230ae", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "28ba403d-2206-4da9-b7c5-ece84eef55a8", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de020528-abcc-4d66-80ce-134aaa64e562", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cadd95d6-7040-4a1d-b5fc-187fc897ee1f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90a770a7-a341-4981-82e7-a6dd03b83457", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69e46711-39cd-49e3-ace6-691840343b49", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b21d14a-2bdb-4e16-af16-a06cd0161b6c", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "99333874-b2a2-4132-9b96-067c25f6750f", "name": "Remove a knowledge base member", "request": { "name": "Remove a knowledge base member", "description": { "content": "Revokes one person's access to the help center. The ThriveDesk user account is untouched, and re-inviting them restores access. Proxied to the help-center service, so the status and body are whatever it returns. Listing and inviting members is not part of this surface.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "knowledgebase_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "email", "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "75d52052-74f0-4e22-be29-270927aa5681", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b5cd7bb-03de-46ad-9553-ff6c6e30e4ca", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0daf6db4-8411-4a59-91fc-481b47f5b85d", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1d28a87-716e-42b0-a8ed-4768bf334e42", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "659d3b28-06aa-44ba-a128-a28ff9df28c8", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af705cd6-5fb9-4663-afd0-668a2c8e6012", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "371d5070-8d17-40bf-b308-8fdf988e16b7", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_id", "users", ":email" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_id" }, { "disabled": false, "description": { "content": "(Required) Email address of the member to remove.", "type": "text/plain" }, "type": "any", "value": "", "key": "email" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "97c2a67d-12b4-4be5-91a7-e44f87d755c0", "name": "List articles", "request": { "name": "List articles", "description": { "content": "List articles.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "knowledgebase_slug", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "57832461-70a2-421a-9845-f4485237f8c5", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"excerpt\": \"\",\n \"published_at\": \"\",\n \"knowledgebase\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"visibility\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"slug\": \"\",\n \"excerpt\": \"\",\n \"published_at\": \"\",\n \"knowledgebase\": {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"visibility\": \"\"\n }\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n },\n \"meta\": {\n \"current_page\": \"\",\n \"from\": \"\",\n \"last_page\": \"\",\n \"per_page\": \"\",\n \"to\": \"\",\n \"total\": \"\",\n \"path\": \"\",\n \"links\": [\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n },\n {\n \"url\": \"\",\n \"label\": \"\",\n \"page\": \"\",\n \"active\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eb5195a-c7a4-4873-9d2b-67ba083c6295", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aef28afc-03b3-4ddc-915e-a87695125035", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "efee7607-bb8c-4f1f-89c1-5e9da3924975", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f20f58ae-05ed-45b3-8b49-8d0370caa3bc", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99b9f415-7088-4903-be04-90603bf0705f", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdf12af2-9333-43d6-a5ba-49aa610e9157", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c78acddc-f1c7-4041-8f2f-45c983810725", "name": "View an article", "request": { "name": "View an article", "description": { "content": "View an article.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "knowledgebase_slug", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "article_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "238e03ce-b8b8-4590-be9e-7e14eb5f01e8", "name": "Success.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 20.392325907403475,\n \"key_1\": 7931.947376051122\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8813b641-a313-46d7-83aa-95a677fd2c8c", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd448700-959a-4370-8e12-b70acbc34ea5", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d09b378e-d6d1-451f-a226-127ddb466159", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6a2af1f-fad9-46f5-bcc2-cfe1df837125", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bdc861a3-5b09-477b-8d76-b5ba76e96f7e", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53c2d6d2-aeae-46a3-b2d6-d66bae388fda", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "knowledgebases", ":knowledgebase_slug", "articles", ":article_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "knowledgebase_slug" }, { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "article_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Attachments", "description": "File uploads and downloads on conversations.", "item": [ { "id": "f0499930-abef-4271-93e8-f8c9612b12b7", "name": "Download an attachment (binary stream)", "request": { "name": "Download an attachment (binary stream)", "description": { "content": "Download an attachment (binary stream).", "type": "text/plain" }, "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "attachmentId", "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "466bd7d5-5553-4f1a-8edc-c3de12639360", "name": "Binary file stream. Content-Disposition header indicates the filename.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" }, { "disabled": false, "description": { "content": "attachment; filename=", "type": "text/plain" }, "key": "Content-Disposition", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4f7b3430-8b7b-4762-83c2-9f7180869c0b", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb1e71b2-2b80-4be7-9a07-58303ed1cb9f", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74eda34a-4b99-4668-bd16-61292bf65afd", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e8953d-cf85-4d2a-8ed6-3f0ca980940f", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb6c4d9d-f71b-4a05-aef2-ad8f8bd1976b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d02a7cbe-468f-41f1-959e-fd2799e3dd36", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1f7361aa-b2e9-4a30-8b9f-be4f6678a78d", "name": "Delete an attachment", "request": { "name": "Delete an attachment", "description": { "content": "Delete an attachment.", "type": "text/plain" }, "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "attachmentId", "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "520a6044-a092-4986-bc44-b7968b4ba474", "name": "Success.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "477b4b9b-5502-4288-8f0d-98809be21c10", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d70f699-df15-4316-ae76-69e962cad7fd", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f8b7c9f-6036-413d-bca9-9069c3a8c2e5", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f44f707-bd94-43ba-9da9-5db3fb3e4c02", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aed196e7-b769-4d1c-bc1b-3777c3cbea5c", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "289105cf-558f-4056-adce-019110828d12", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "attachments", ":attachmentId", "delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Attachment identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "attachmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae363127-8d7f-4c87-bb98-19c5a62fde5f", "name": "Upload attachments to a conversation draft", "request": { "name": "Upload attachments to a conversation draft", "description": { "content": "Upload attachments to a conversation draft.", "type": "text/plain" }, "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "conversationId", "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c857f9d4-4be1-4d55-a5e0-2c910f69d2c7", "name": "Success.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"draft_id\": \"\",\n \"data\": [\n {\n \"attachment_id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\",\n \"inline\": \"\"\n },\n {\n \"attachment_id\": \"\",\n \"name\": \"\",\n \"size\": \"\",\n \"type\": \"\",\n \"inline\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc04efc6-7303-47ce-b8d6-240982f6aa74", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54f698d4-4ee4-431f-a40c-97db62d8beeb", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d39e257-706a-4bd7-ad36-e351aa33ae9b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4476af21-0eb8-4dbf-ba13-650119184552", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d62ea753-8405-42e2-8673-cf50552be40b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4ff93ea-0957-4147-bd10-00336c59b570", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "attachments", "conversation", ":conversationId", "attachment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Conversation identifier. Named in camelCase, unlike the snake_case path parameters elsewhere.", "type": "text/plain" }, "type": "any", "value": "", "key": "conversationId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) One or more files.", "type": "text/plain" }, "key": "attachments[]", "value": ",", "type": "text" }, { "description": { "content": "Draft message to attach to. Pass the literal string \"null\" to create a draft on the fly.", "type": "text/plain" }, "key": "draft_id", "value": "", "type": "text" }, { "description": { "content": "Mark the files as inline images.", "type": "text/plain" }, "key": "is_inline", "value": "", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Messages and Notes", "description": "Thread events: message bodies and internal notes.", "item": [ { "id": "4314c7eb-f2ec-45b9-9c09-b4389f989cf6", "name": "View a single message body", "request": { "name": "View a single message body", "description": { "content": "View a single message body.", "type": "text/plain" }, "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a10eb3a7-90a9-43de-8262-9fe4b466f68a", "name": "Success.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"html_body\": \"\",\n \"cc\": null,\n \"bcc\": null,\n \"extra\": {\n \"key_0\": 3405,\n \"key_1\": \"string\"\n },\n \"created_at\": \"\",\n \"conversation\": {\n \"id\": \"\",\n \"inbox_id\": \"\",\n \"ticket_id\": \"\",\n \"has_attachment\": \"\",\n \"has_inline_attachment\": \"\",\n \"is_draft\": \"\",\n \"is_scheduled\": \"\",\n \"is_snoozed\": \"\",\n \"active\": \"\",\n \"subject\": \"\",\n \"updated_subject\": \"\",\n \"status\": \"Closed\",\n \"is_spam\": \"\",\n \"priority\": \"High\",\n \"assignable_type\": \"\",\n \"assignable_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"deleted_at\": \"\",\n \"closed_at\": \"\",\n \"excerpt\": \"\",\n \"messages_count\": \"\",\n \"last_message_created_at\": \"\",\n \"intended_inbox_address_id\": \"\",\n \"agents\": [\n \"\",\n \"\"\n ],\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"conversations_count\": \"\"\n },\n \"last_message\": {\n \"id\": \"\",\n \"cc\": null,\n \"bcc\": [\n \"\",\n \"\"\n ],\n \"record_type\": \"\",\n \"status\": \"\",\n \"direction\": \"\",\n \"viewed_at\": \"\",\n \"created_at\": \"\",\n \"text_body\": \"\",\n \"excerpt\": \"\",\n \"html_body\": \"\",\n \"extra\": {},\n \"is_clipped\": \"\",\n \"intended_inbox_address_id\": \"\"\n },\n \"custom_field_values\": {},\n \"viewer_id\": \"\",\n \"viewed_at\": \"\",\n \"last_message_by\": \"\"\n },\n \"contact\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"avatar\": \"\",\n \"company\": \"\",\n \"website\": \"\",\n \"job_title\": \"\",\n \"address\": \"\",\n \"should_display_image\": \"\",\n \"notes\": \"\",\n \"extra\": {},\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n \"inbox\": {\n \"id\": \"\",\n \"name\": \"\",\n \"inbox_address\": \"\",\n \"connected_email_address\": \"\",\n \"email_forwarding_enabled\": \"\",\n \"from_name\": \"\",\n \"default_status\": \"\",\n \"default_assignee\": \"\",\n \"signature\": \"\",\n \"auto_bcc_enabled\": \"\",\n \"auto_bcc\": \"\",\n \"auto_reply_enabled\": \"\",\n \"auto_reply_subject\": \"\",\n \"auto_reply_body\": \"\",\n \"off_hours_auto_reply_subject\": \"\",\n \"off_hours_auto_reply_body\": \"\",\n \"satisfaction_ratings_enabled\": \"\",\n \"satisfaction_ratings\": {},\n \"extra\": {},\n \"organization_id\": \"\",\n \"deleted_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"reply_as_alias\": \"\",\n \"insert_signature\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0afe0aa-ce09-4bbb-aede-f3cd3fd105fb", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec703e58-b322-4d29-afc4-27071a1f9a8d", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d8766cd-c03b-4323-b30a-91e84756251b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18661db8-b6df-405f-ac6e-f243c2f56b4f", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1967f56-5106-420a-8445-0e5cf6f0db66", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfddd9ad-5dec-4be6-9f77-295d401307c8", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e166d29-7825-449b-8484-fa6a61b3c6b5", "name": "Update a message", "request": { "name": "Update a message", "description": { "content": "Update a message.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e47a64c-2400-40b5-8e86-e5c69234ccdb", "name": "Success.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be21c8a-b02f-4e51-8a3e-3476734eaf2a", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "685189e1-9d40-4b00-8c9e-f69578d035cd", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6afdf7f-a123-487f-9671-896bd797d259", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "389cb7e7-11c4-4385-bfbd-588c1b134726", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62036c80-9ad7-47f0-b189-b5591bb93235", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00b89621-9de4-41a1-a1a8-ff7a69147107", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "messages", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e70ca2d6-1bd1-42c8-9772-6a70961bc79c", "name": "Update a note", "request": { "name": "Update a note", "description": { "content": "Update a note.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b85975b2-91d5-4d6e-84d2-421ec29e3bac", "name": "Success.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a9673b0-8ce5-473b-a299-6a9bfc09d9b4", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e49aeb8-2cd8-48bd-b057-3a7b8b3d55e0", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71ef61e0-f77c-454e-ae96-ce1f4a4d0d29", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "afbd4e1e-3d68-4592-988f-0e0ee6c8e67a", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54d1b56a-adab-4fce-bccb-c23cb8c0f55b", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "750b07d7-efa2-4bff-9202-0f91da3913f6", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"html_body\": \"\",\n \"text_body\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3dfad533-480f-4cef-8558-99e7345a4691", "name": "Delete a note", "request": { "name": "Delete a note", "description": { "content": "Delete a note.\n\nPersonal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.", "type": "text/plain" }, "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "message_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "98e4c7c0-255f-4543-a297-5bcca230ed12", "name": "Success.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e390e66d-1f34-4d22-be59-609f394f2f89", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a89e485c-63cc-494d-b590-f8d783bfe91d", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71beadb8-fa77-401a-97af-755a3c62bdb3", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a01924fd-d7db-4daf-999f-e5e6c5a77c30", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0ff3780-ab1c-456e-b25a-d57a566bc75d", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43f479b6-44ec-4924-867d-007d355a191a", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "notes", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "message_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Misc", "description": "Utilities: current user (`/v1/me`) and global search (`/v1/search`).", "item": [ { "id": "0bda2479-0b9a-49d0-9d0f-6bf196f61c63", "name": "Get current user, organization, and badge counts", "request": { "name": "Get current user, organization, and badge counts", "description": { "content": "Get current user, organization, and badge counts.", "type": "text/plain" }, "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8e92df60-13ca-40ae-b912-721e0d41c3cb", "name": "Success.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"company\": {\n \"id\": \"\",\n \"owner_id\": \"\",\n \"company\": \"\",\n \"slug\": \"\",\n \"options\": {},\n \"permissions\": {},\n \"domain\": {\n \"id\": \"\",\n \"domain\": \"\",\n \"config\": {},\n \"authorized\": \"\",\n \"extra\": {},\n \"organization_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n },\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"job_title\": \"\",\n \"avatar\": \"\",\n \"role\": \"User\",\n \"presence\": null,\n \"timezone\": \"\",\n \"time_format\": \"\",\n \"active_organization_id\": \"\",\n \"created_at\": \"\",\n \"extra\": {\n \"password_reset_required\": \"\",\n \"notification_preferences\": {\n \"key_0\": 6592\n },\n \"firebase_notification_preferences\": {\n \"key_0\": \"string\",\n \"key_1\": 3257,\n \"key_2\": 1511.2713060357419\n },\n \"mobile_notification_preferences\": {\n \"key_0\": true\n },\n \"auto_advance_ticket_enabled\": \"\",\n \"undo_send_enabled\": \"\",\n \"undo_send_delay\": \"\"\n }\n },\n \"inboxes\": [\n \"\",\n \"\"\n ],\n \"organizations\": [\n {\n \"id\": \"\",\n \"company\": \"\",\n \"slug\": \"\",\n \"owner_id\": \"\",\n \"assigned_tickets_count\": \"\"\n },\n {\n \"id\": \"\",\n \"company\": \"\",\n \"slug\": \"\",\n \"owner_id\": \"\",\n \"assigned_tickets_count\": \"\"\n }\n ],\n \"onboarding\": {\n \"key_0\": 4974\n },\n \"had_onboarding_survey\": \"\",\n \"badge_count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07d1731c-e973-45d7-87df-255402f8ba5b", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85c3e23f-a3e8-4c32-b024-e05e411a34cb", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c1da64-1aac-4b4d-bffe-cb0ac7733e62", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60469a9b-8cf3-459c-9f95-9215e379f717", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a09bc2d-91ca-4ceb-b554-dcb6abb8f5e4", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751b6e76-d7e3-45df-bbcb-fc80d0817ba9", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be12be44-0c16-4d11-a5c3-23869d681874", "name": "Search conversations", "request": { "name": "Search conversations", "description": { "content": "Search conversations.", "type": "text/plain" }, "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0bc4a9ef-29de-415f-a726-cf0dc6d880e4", "name": "Success.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"data\": {\n \"conversations\": {}\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "907d1b6c-8b5c-4307-9277-137d5fa14bba", "name": "Missing or invalid bearer token.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3829daef-8422-43b3-8b77-14cd568da343", "name": "Token is valid but does not include a required scope, or the user does not have access to the resource.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79092f68-9b52-403c-a093-a8042159d85a", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23bdaee4-d878-4803-aa07-e7e6f1e75a78", "name": "Request body failed validation.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ]\n },\n \"message\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "814f3b1c-6446-43e9-a066-294632aeafe0", "name": "Rate limit exceeded. The `Retry-After` header indicates how long to wait\nbefore retrying. See [Pagination and rate limits](/get-started/pagination) for\nthe full rate-limit policy.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8377d6d5-b6c6-4c11-92c4-6bd16474d704", "name": "Unexpected server error.", "originalRequest": { "url": { "path": [ "search" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"q\": {\n \"key_0\": 3784\n },\n \"per-page\": 20,\n \"sort\": \"newest\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"\",\n \"errors\": {\n \"key_0\": [\n \"\",\n \"\"\n ],\n \"key_1\": [\n \"\",\n \"\"\n ],\n \"key_2\": [\n \"\",\n \"\"\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{bearerToken}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.thrivedesk.com/v1" } ], "info": { "_postman_id": "92e644e8-c592-405d-b74d-aa203ef27b31", "name": "ThriveDesk Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "The ThriveDesk Public API gives external integrators programmatic access\nto conversations, contacts, inboxes, tags, saved replies, reports, and the\nKnowledge Base. The same surface that powers the ThriveDesk web app is\navailable here, scoped via bearer access tokens.\n\n## Quick links\n\n- [Quickstart](/get-started/quickstart)\n- [Authentication and scopes](/get-started/authentication)\n- [Errors](/get-started/errors)\n- [Pagination and rate limits](/get-started/pagination)\n- [Assistant SDK](/assistant/overview)\n- [Webhooks](/webhooks/overview)\n- [SmartApp](/smartapp/overview)\n- [Changelog](/get-started/changelog)\n\n## What is documented\n\nThe 90 endpoints in this spec cover the helpdesk data plane:\nconversations, contacts, inboxes (with their automations, custom fields,\nand saved replies), tags, teammates, saved replies, business hours and\nholidays, reports, the Knowledge Base, attachments, messages, notes, and\nthe search and `me` utilities.\n\nFirst-party app, billing, onboarding,\nbroadcasting, widget, webhook, and admin-dashboard endpoints are not part\nof this REST surface. The separate [Assistant SDK](/assistant/overview),\n[webhook](/webhooks/overview), and [SmartApp](/smartapp/overview)\ncontracts are documented as sibling integration surfaces. The same goes for the web\napp's own session and UI mechanics (password login, undo-send, saved-view\nand folder creation, usage counters) and for admin-plane writes\n(automation create and update, Knowledge Base member invitation, bulk\npermanent deletion): those routes exist for the first-party clients but\nare not supported for integrations.\n\n## Deleting data\n\nDeletes are not uniform. Some are recoverable, some destroy related\nrecords and stored files outright, and the response body does not say\nwhich is which. Every delete operation carries a description saying what\nit removes and whether there is a way back. Read it before you call it.\n\n## Compatibility\n\n- OpenAPI 3.1\n- All requests are `application/json` except for attachment downloads\n (binary stream).\n- All responses are `application/json` except for attachment downloads.\n\n\nContact Support:\n Name: ThriveDesk Developer Support\n Email: help@thrivedesk.com", "type": "text/plain" } } }