{ "item": [ { "name": "🔑 Authentication", "item": [ { "name": "Validate API key", "request": { "name": "Validate API key", "description": "Calls GET /v1/account to confirm your API key is valid. On success, the test script confirms the key and prints the account name. Use this as the first request after pasting your apiKey into the environment.", "method": "GET", "url": { "host": [ "{{baseUrl}}" ], "path": [ "v1", "account" ], "query": [], "variable": [] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "header": [] }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('200 OK', () => pm.response.to.have.status(200));", "pm.test('returns an account id', () => {", " const json = pm.response.json();", " pm.expect(json).to.have.property('id');", " console.log('Authenticated as account:', json.name || json.id);", "});" ] } } ] } ] }, { "id": "293505b0-2998-4266-ade7-6632088a2357", "name": "Account", "description": { "content": "Account metadata for the authenticated API key.", "type": "text/plain" }, "item": [ { "id": "5ef59ed9-f7b3-4844-901b-dd4afcdf82a7", "name": "Get account", "request": { "name": "Get account", "description": { "content": "Retrieve the account the API key belongs to.", "type": "text/plain" }, "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3fea4f0b-a63c-435c-b0e1-009b54b8c9a1", "name": "success", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"user_email\": \"string\",\n \"timezone\": \"string\",\n \"created_at\": \"2002-12-09T17:29:17.224Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98eb3269-84d3-4cd6-b178-20bd02c02e2f", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6e7dce56-fa18-4936-97b4-136d91eee8af", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7e5988a-8e32-4120-899b-22a27d2031de", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee021509-a514-44b1-ada0-993a05458735", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fc03100-d65d-466e-ae85-cbf5b6cab4ad", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2dc8a96-fc2a-43be-b890-db981c680104", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d1c7d92a-38ff-4e80-bcfe-d5ecfea35a53", "name": "Audiences", "description": { "content": "Reusable contact lists used as targets for messages and campaigns.", "type": "text/plain" }, "item": [ { "id": "86dafeb8-fd0d-45f7-a634-57cfa2079fc8", "name": "List audiences", "request": { "name": "List audiences", "description": { "content": "List the audiences in your workspace, newest first. Offset-paginated via `limit` + `skip`. Requires `audiences:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (default 50, max 200)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "809b1db9-928a-409e-8b8c-6c9a0422e100", "name": "audiences", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"contact_count\": 1504,\n \"created_at\": \"1970-03-09T05:32:37.165Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"contact_count\": 720,\n \"created_at\": \"2025-12-06T02:52:59.542Z\"\n }\n ],\n \"limit\": 9649,\n \"skip\": 2080,\n \"total\": 4337\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d4e84e1-5eb9-40ed-8706-ec865a707d37", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c412e3d-147e-46b4-bf74-66567eb50cba", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1da70e8-716b-4482-a00b-1f22af3e0498", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7853b06c-1f39-41c6-accc-cfeab4c604b8", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49095686-f65c-45ec-8f13-7e4343b80a7c", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1c143a-77c2-461b-a846-f3969de98351", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48bc1d1e-7471-4b55-b462-44d7c24f8605", "name": "Create audience", "request": { "name": "Create audience", "description": { "content": "Create a new audience. Returns the audience with `contact_count: 0`. Requires `audiences:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n },\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "6f728e21-d32c-4ba9-b10b-5e8169672f92", "name": "created", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"contact_count\": 6899,\n \"created_at\": \"1997-04-07T15:58:34.278Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bad1455-a2dd-4594-b9bf-5df0d5db44d7", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1eb8539b-d090-4d09-b34d-6fd0e9cd71f0", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3bf3671-7359-410a-9b4b-366097981151", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "204e8cf4-b9b5-43c5-8fe3-050cd5e9ff12", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc5ceb1c-0ce8-4e78-afde-08d31285906f", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b33565b-1df7-44aa-932b-f311858872bd", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Newsletter Recipients\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "42697e62-859c-4598-a8e8-a4a2e7582868", "name": "Get audience", "request": { "name": "Get audience", "description": { "content": "Retrieve a single audience by id, including its `contact_count` and variable schema. Requires `audiences:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cf2655dc-dfa1-454d-8371-e42555760861", "name": "audience", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"contact_count\": 6899,\n \"created_at\": \"1997-04-07T15:58:34.278Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c24c341-2020-4475-be89-1f48df61f166", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67b5a98b-6864-4c68-9331-fc93e501aa7d", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "042c417d-12cd-4913-b49c-782a32ca61e7", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d085728c-1d62-4256-adda-99bed38bed34", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a256536-7f37-4b12-8711-ceaaed82573a", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c2622d2-f320-4bb0-96a7-35f1d11d5ac6", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67219885-c695-4082-a9ea-81573a50ad88", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f5459890-99dd-4120-a4a9-cc051975a3d5", "name": "Update audience", "request": { "name": "Update audience", "description": { "content": "Rename an audience or update its variable schema. Requires `audiences:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "5ad05a1d-2b22-4b02-9ad8-55c0d02fb26c", "name": "updated", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"contact_count\": 6899,\n \"created_at\": \"1997-04-07T15:58:34.278Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd031254-6dad-4107-8565-82ab1a20377b", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9d0bd02-fd5b-4b5e-8cd7-6d7d2e58b789", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12714756-4737-4438-abdb-b22507ea05e9", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33362b6c-3eb7-4532-83f6-e00540554a8c", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e460625-dbdc-4e3f-8bea-0672935cf609", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f13b4bbb-5c81-4228-a430-59abe7bb82e0", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f02002c-559b-4f4b-aa5d-e976d0c6b8d6", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b6e7c46-a010-4ff2-9e10-fc044c86e16d", "name": "Delete audience", "request": { "name": "Delete audience", "description": { "content": "Soft-delete an audience. 409 if it`s referenced by an active campaign. Returns the deleted ref. Requires `audiences:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "67acc151-7ca5-4f56-8ad8-ee4c43683ced", "name": "deleted", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"deleted\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1850b306-e0a2-4fb4-9058-2e7cecc0e574", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a4f49d4-f36e-4cbe-a872-60d8bda1dfe1", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "125e05f6-9241-46bf-89c8-af0390732b6d", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae461fd6-9244-4ba1-b384-f44bd195570c", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e99d3a86-9c1b-49a2-9aba-338d0a21176c", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff13e1b5-e7e6-4d37-97e8-c8bf40521fce", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21c55d87-c236-4d77-9347-b28ff55266dc", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b4b4212c-b521-4b8d-9404-cdba74b2cc18", "name": "Append contacts to audience", "request": { "name": "Append contacts to audience", "description": { "content": "Append contacts to an audience. Duplicates (by `to`) are skipped. Requires `audiences:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e4a7dcb-9e2c-4754-b585-5a011f498314", "name": "appended", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"added\": 2101,\n \"contact_count\": 7016\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d24b74dd-1210-4a0a-9461-95378aef6f59", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df471c59-12b9-4b38-9e19-20c4918c0403", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "166562d0-075d-4b47-94f5-0a2a8ea044ee", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d1dbebd-2cc9-46b9-b3d3-83513df0bed7", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73051312-c4d8-4d5b-8080-05405e4d3445", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00832ced-1102-4da3-bc86-0c741a4ef162", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f0e0600-9040-4764-8211-4b0084a0bac6", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0ce1c741-8dc3-4514-8330-edfc68eb7d6f", "name": "Update audience contact", "request": { "name": "Update audience contact", "description": { "content": "Edit a contact`s phone or variables. Requires `audiences:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "08eda600-1f9d-4796-981f-56609399b0cd", "name": "updated", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"to\": \"string\",\n \"variables\": {\n \"key_0\": \"string\"\n },\n \"added_at\": \"1952-06-08T14:07:38.068Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "279d6352-5207-4011-a1df-056e3417e9ea", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b65a431f-24a8-4bd3-a13b-a0a63453bf22", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9f749f0-d177-436b-8d92-d878fd130992", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c33e435-c13a-49bc-a599-74177c84f823", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d110fb2-b74f-4728-8868-8df223e40519", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c416ba-cf56-4112-befa-107d6bbebf92", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd1fc233-9079-467e-936f-b0d32506c4c4", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b1b8a798-50a0-446a-8609-26c298f0d506", "name": "Remove audience contact", "request": { "name": "Remove audience contact", "description": { "content": "Remove a contact from an audience. Requires `audiences:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "64220c6e-9c45-47bd-b141-5ade0593496e", "name": "deleted", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "101b2c89-f9d9-4a8e-be45-bcc8b8ba8648", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aee527ba-f766-42ac-b40d-71e767745e76", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ef6d238-6d93-47b1-af3c-322705107b41", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82ddd2ca-f907-49b8-a311-fbb64723d221", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95840ab8-8fd8-405e-8df9-990238981fd4", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f213afa6-790c-4d64-97ea-7b7608baa7be", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7f7ca50-a4b3-4f78-8ddc-d3a461bb2944", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences", ":id", "contacts", ":contactId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "contactId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "1fecdb79-3569-4b38-8caf-2ee849946cad", "name": "Campaigns", "description": { "content": "Schedule audiences for paced bulk delivery with pause/resume/cancel controls.", "type": "text/plain" }, "item": [ { "id": "787eb0c8-d92d-40b6-a636-96b6f0fdb3be", "name": "List campaigns", "request": { "name": "List campaigns", "description": { "content": "List the campaigns in your workspace, newest first, each with its live counters (`sent_count`, `delivered_count`, `read_count`, `failed_count`). Offset-paginated via `limit` + `skip`. Requires `campaigns:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (default 50, max 200)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "420d1d9f-aae5-43a1-8e2c-edbc05e04a5e", "name": "campaigns", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"running\",\n \"total_count\": 4233,\n \"sent_count\": 5915,\n \"delivered_count\": 6332,\n \"read_count\": 1105,\n \"failed_count\": 6005,\n \"from\": \"string\",\n \"created_at\": \"2005-08-01T13:46:30.832Z\",\n \"started_at\": \"2025-06-20T02:55:17.057Z\",\n \"completed_at\": \"1964-05-26T22:27:17.800Z\",\n \"aborted_at\": \"2003-06-18T20:21:59.806Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"paused\",\n \"total_count\": 3322,\n \"sent_count\": 7889,\n \"delivered_count\": 8942,\n \"read_count\": 3678,\n \"failed_count\": 7645,\n \"from\": \"string\",\n \"created_at\": \"1969-03-06T15:51:30.976Z\",\n \"started_at\": \"1976-05-09T10:32:36.681Z\",\n \"completed_at\": \"1988-01-26T15:28:40.033Z\",\n \"aborted_at\": \"1991-05-29T05:41:52.132Z\"\n }\n ],\n \"limit\": 1287,\n \"skip\": 6537,\n \"total\": 8141\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bc8e850-6382-46dc-86b7-68aa40b89f68", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d029860-e9b8-431d-951c-cf177aa09b9a", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad7433a9-959d-4e06-ad23-52b3e02aa43a", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "311e3c03-4b59-47c6-a332-11013c2f92ca", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f8e28f1-2cde-4dcd-9972-785a7b25ffb0", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05c9a7a3-7223-4828-8513-0b786b2ce573", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe9cd1bb-70ef-42ca-8a00-8aaee510060c", "name": "Create campaign", "request": { "name": "Create campaign", "description": { "content": "Schedule a new bulk-message campaign. Returns the campaign in `pending` state. Requires `campaigns:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "25b404af-a23d-46d2-868a-f87417d52264", "name": "created", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"complete_delivered\",\n \"total_count\": 4880,\n \"sent_count\": 5806,\n \"delivered_count\": 7742,\n \"read_count\": 3827,\n \"failed_count\": 7604,\n \"from\": \"string\",\n \"created_at\": \"1968-01-02T02:06:40.212Z\",\n \"started_at\": \"1994-10-13T20:37:28.291Z\",\n \"completed_at\": \"1999-03-30T07:23:57.836Z\",\n \"aborted_at\": \"2018-06-01T23:42:43.592Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79472c06-fa0b-4987-b6f5-007d3dee33c3", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ef68b74-02e7-47af-938f-dbc37c4a68db", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00766728-637f-4f79-a36a-4178317b805b", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "775e93cd-9c36-4c0a-86bd-a24e5b7797c7", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "267f6f8a-fc86-49e7-8f8d-c7cc0e915607", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bce8eb3-f02b-4cba-bcfc-57b888ec249d", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"audience_id\": \"\",\n \"text\": \"\",\n \"media_url\": \"\",\n \"media_caption\": \"\",\n \"from\": \"\",\n \"on_missing_variable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f10d67c-0f3c-4ef9-b4c3-955d9874ed59", "name": "Get campaign", "request": { "name": "Get campaign", "description": { "content": "Retrieve a single campaign by id, including its status and live delivery counters. Poll this to track progress. Requires `campaigns:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c614ba5c-7f26-4423-b503-d30b1904793b", "name": "campaign", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"complete_delivered\",\n \"total_count\": 4880,\n \"sent_count\": 5806,\n \"delivered_count\": 7742,\n \"read_count\": 3827,\n \"failed_count\": 7604,\n \"from\": \"string\",\n \"created_at\": \"1968-01-02T02:06:40.212Z\",\n \"started_at\": \"1994-10-13T20:37:28.291Z\",\n \"completed_at\": \"1999-03-30T07:23:57.836Z\",\n \"aborted_at\": \"2018-06-01T23:42:43.592Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b6070ab-75d6-4c7e-9b93-086fc6d5593d", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "382ae00c-8738-4e48-8e27-1b21d0fb2d7d", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "139bb8f4-e305-4e2d-9d24-fa1f60866a74", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfb5b71-f85a-479d-8771-f10c8b7eb3cc", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14efbc3c-0e75-4658-b4cc-2a5d65f7485b", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b67b446a-bca5-442b-9652-e1c3af56696c", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8c1ca3e-ec06-40c9-aa10-fde55b489d9e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa4638c6-7a30-44c3-8151-fc35ded497f1", "name": "Pause campaign", "request": { "name": "Pause campaign", "description": { "content": "Pause a running campaign. 409 if not `running`. Requires `campaigns:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "73401c9a-5cd1-4454-adcd-9791533c5c29", "name": "paused", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"complete_delivered\",\n \"total_count\": 4880,\n \"sent_count\": 5806,\n \"delivered_count\": 7742,\n \"read_count\": 3827,\n \"failed_count\": 7604,\n \"from\": \"string\",\n \"created_at\": \"1968-01-02T02:06:40.212Z\",\n \"started_at\": \"1994-10-13T20:37:28.291Z\",\n \"completed_at\": \"1999-03-30T07:23:57.836Z\",\n \"aborted_at\": \"2018-06-01T23:42:43.592Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "abfedca2-7c6e-493b-86e6-3ba100d6ca6c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f42206a4-d3b2-4d99-8982-57fbde688177", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d44f239f-f670-43cc-8786-9df16ab15520", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "007184aa-2293-40cf-8f59-d5685f88456f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "92f587c9-08c1-4ac3-b10c-68146f862030", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac0c26f2-a994-4b03-9729-2af14a93a535", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c357e3a-d9c2-40cc-be3d-2c864ae59c8c", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "pause" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f3480865-ccd1-49a9-9e3a-d46ac2af38ca", "name": "Resume campaign", "request": { "name": "Resume campaign", "description": { "content": "Resume a paused campaign. 409 if not `paused`. Requires `campaigns:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "38d04e0b-01a7-4080-b8be-a7f8fcaf635f", "name": "resumed", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"complete_delivered\",\n \"total_count\": 4880,\n \"sent_count\": 5806,\n \"delivered_count\": 7742,\n \"read_count\": 3827,\n \"failed_count\": 7604,\n \"from\": \"string\",\n \"created_at\": \"1968-01-02T02:06:40.212Z\",\n \"started_at\": \"1994-10-13T20:37:28.291Z\",\n \"completed_at\": \"1999-03-30T07:23:57.836Z\",\n \"aborted_at\": \"2018-06-01T23:42:43.592Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6997e801-fdc8-41ff-a69f-ae22770a4892", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eae67396-63d6-4d36-9cec-2c81b9f6f194", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ea80f7a-54a9-45a9-a180-e4f0726e7e47", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "208d473b-4b42-4cae-a91b-502743625c5f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2da8e3d8-f7dc-4776-b4dc-b113764df84b", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d5db3f8-9d10-4a87-a203-f3f2c1ead185", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d713b33-1032-4d4d-8fe7-948e3cc1f808", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "resume" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "92b21629-d1ed-4ad2-91b0-d6648b357e57", "name": "Cancel campaign", "request": { "name": "Cancel campaign", "description": { "content": "Cancel a campaign. 409 if already terminal. Requires `campaigns:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "98f02e13-bbab-4622-8fdf-5294b42164ef", "name": "aborted", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"audience_id\": \"string\",\n \"status\": \"complete_delivered\",\n \"total_count\": 4880,\n \"sent_count\": 5806,\n \"delivered_count\": 7742,\n \"read_count\": 3827,\n \"failed_count\": 7604,\n \"from\": \"string\",\n \"created_at\": \"1968-01-02T02:06:40.212Z\",\n \"started_at\": \"1994-10-13T20:37:28.291Z\",\n \"completed_at\": \"1999-03-30T07:23:57.836Z\",\n \"aborted_at\": \"2018-06-01T23:42:43.592Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbaf7937-4c8d-4457-af77-5e24ef7e8656", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c457b7f7-df80-48dc-ac7c-8557a1ed0369", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c18c47d4-b72c-4689-a431-2776d619d3e4", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "025498bf-4779-4bce-81d1-ebfa8c28e7ec", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "454278a6-9a6d-4406-bbb1-5f033a8fc74e", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "85541424-1b9c-464e-a6a1-75b7c7cca43e", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eccb407c-75e2-4fb5-9dfb-3418cf7eeac2", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "504e328e-c230-4972-8512-55de9663a17f", "name": "Chats", "description": { "content": "Read and manage WhatsApp chats on the connected engine.", "type": "text/plain" }, "item": [ { "id": "9029766d-539f-46a4-8794-62be4806264a", "name": "List chats", "request": { "name": "List chats", "description": { "content": "List the chats (conversations) the connected WhatsApp engine sees, most-recent first. Offset-paginated via `limit` + `skip`, with an optional case-insensitive substring search on the chat name via `searchToken` and a `filter` to restrict to one chat kind. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only items whose name matches are returned." }, { "disabled": false, "key": "filter", "value": "", "description": "Restrict to one chat kind." }, { "disabled": false, "key": "include_last_message", "value": "", "description": "Include the last message snippet on each chat row." }, { "disabled": false, "key": "include_extended_info", "value": "", "description": "Include extended chat metadata (engine-side opt-in)." }, { "disabled": false, "key": "include_without_name", "value": "", "description": "Include chats with no resolved name (default: skipped)." }, { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (1-200, default 50)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8b10a9ed-1056-4211-bc94-5c6fcb9dfbd6", "name": "chats", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"is_group\": true,\n \"is_newsletter\": false,\n \"last_message_at\": \"1950-12-29T13:56:42.276Z\",\n \"unread_count\": 8866,\n \"marked_unread\": false\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"is_group\": true,\n \"is_newsletter\": false,\n \"last_message_at\": \"1958-02-15T20:41:17.315Z\",\n \"unread_count\": 2107,\n \"marked_unread\": false\n }\n ],\n \"limit\": 5865,\n \"skip\": 4992,\n \"total\": 8159\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "675331a0-5924-421f-b730-6557f82e3819", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34e0115e-f48b-442b-9d34-91938a74a21f", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88f7fce6-043e-4df6-895d-134e5fd74d90", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a771f48f-eae3-4eba-a590-d45b69addd0e", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "456c0e91-82cf-4e3c-8a2b-795dee35a4b0", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27ac5814-022f-4f74-a8af-573aec80716a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "include_last_message", "value": "" }, { "key": "include_extended_info", "value": "" }, { "key": "include_without_name", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "492be130-33ac-4b7d-b577-18fa76f4adc9", "name": "Get chat", "request": { "name": "Get chat", "description": { "content": "Retrieve a single chat by its id — a phone number in international format (e.g. +14155551234) or a WhatsApp JID (`@c.us`, `@g.us`, or `@newsletter`). Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d601b31e-b33d-4876-b1da-c2402e83b770", "name": "chat", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"is_group\": true,\n \"is_newsletter\": true,\n \"last_message_at\": \"1993-10-27T14:46:37.407Z\",\n \"unread_count\": 3097,\n \"marked_unread\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7053b83a-4eb3-4b23-b012-906ace02fe0d", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5d46453-08fd-47a3-90ed-f5cf6b878736", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be45e41-3d96-4bd3-a94c-95fb8f607f0e", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "912dc308-4439-46e0-a23d-3b8688e2ccec", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33961837-cd8a-45e2-be46-f99609beb46e", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c05ab47-b414-4504-91d9-21a74afa75c1", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6211bfcc-d163-484e-9e99-1615ed9d543a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8cbf851-3bbb-4e61-bc18-81b5a40644a9", "name": "List chat participants", "request": { "name": "List chat participants", "description": { "content": "For group chats, returns the participant list (paginated). For DMs, returns the single counterparty. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only participants whose resolved name or phone/JID matches (case-insensitive substring) are returned, and `total` reflects the matched count." }, { "disabled": false, "key": "skip", "value": "0", "description": "Number of participants to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "100", "description": "Max participants to return." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9a7e2bb2-228f-48bc-9d01-ccbf1ba5046b", "name": "participants", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false\n }\n ],\n \"limit\": 1334,\n \"skip\": 6997,\n \"total\": 4153\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5a6bf58-057c-4a52-a9c5-cb04237115c9", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccb5feeb-a2d9-460f-8fae-c0048867aaba", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "776e6e4a-4201-48e7-aced-23c655adc1f2", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c808592-31fd-49ea-b2d5-9cf0bdec32ed", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "815bb0e9-0238-4290-902d-a5921fe94dff", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c139a7b-9c50-49e9-bfd5-6dbae7a00ae3", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a1ed4b2-5c69-47f6-9bb4-72b275bada3e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "86e9068a-07b0-4429-80aa-e623312a2c44", "name": "Mark chat as read", "request": { "name": "Mark chat as read", "description": { "content": "Clears the unread badge on the connected engine for the given chat. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b89726c3-b643-4dd0-8ed1-9395be0b1525", "name": "marked read", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"ok\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73160ff7-db50-4f90-98ab-f6bcada7f00e", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dca19df-cb0f-441c-8d09-6dd3f95a4d44", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f906ab1-32bd-497f-9d66-962ed13fdfb8", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "625aaef5-6bb7-4879-935b-8330a404cadc", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "849bc5ad-42bf-44be-9fb8-c40c86c06249", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41a46aad-be74-42c4-9b16-8fea9135745b", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3c5546d-a632-4f19-913d-8436de11c714", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "359b0130-cbbf-489e-9de6-b47aa7121672", "name": "Open chat in engine", "request": { "name": "Open chat in engine", "description": { "content": "Brings the chat to the foreground on the connected WhatsApp Web client (creates the chat if it doesn`t exist yet for the engine). Useful before issuing follow-up reads on a fresh JID. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e41eaa29-3093-4633-8753-5fe8e64ba426", "name": "opened", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"chat_id\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "056b69f0-439b-4b0f-8e8a-7bb4cf9a1138", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12f3db5e-57e3-4952-9ce7-e89f99e708bf", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ea9b318-75af-4837-96c1-c97e02317ac4", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0948394-ee4c-45a4-be07-dda44140ce66", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d5c0434-5201-43d9-8f8d-eee6c7b889e5", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b87ce09a-1031-4ca2-8db6-18454f4c226f", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb958111-261f-4d54-8b78-11cad0c4ff85", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chat_id", "open" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "34fd2ea8-89c5-4308-b736-a32066ebcd82", "name": "Contacts", "description": { "content": "Read WhatsApp contacts known to the connected engine.", "type": "text/plain" }, "item": [ { "id": "dc583950-0670-4ba9-9e44-6ddd55020e92", "name": "List contacts", "request": { "name": "List contacts", "description": { "content": "List your workspace contact book — everyone the connected WhatsApp account has messaged. Offset-paginated via `limit` + `skip`. Requires `contacts:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only items whose name matches are returned." }, { "disabled": false, "key": "skip", "value": "", "description": "Number of contacts to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "", "description": "Page size (default 10, max 200). Pass `-1` to return every contact in a single page." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3ba4c222-0070-4106-bde1-12f4bf003afb", "name": "contacts", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"chat_id\": \"string\",\n \"name\": \"string\",\n \"is_business\": true\n },\n {\n \"chat_id\": \"string\",\n \"name\": \"string\",\n \"is_business\": false\n }\n ],\n \"limit\": 9135,\n \"skip\": 6047,\n \"total\": 2189\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ef0d6ec-f531-48d1-b277-b3019c3e532c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6a3317e-0bba-4fad-81db-3f9fea1d33d3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "279cfb20-f42f-4a86-9a21-8cd2e945d779", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "481959f5-768c-4498-ad3c-db419ddf59ec", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86a37533-467d-4444-aa0f-87ac72eb4a35", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d792b99-027b-4082-ad3f-4cbb7b205c23", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "" }, { "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a4cb403e-0873-40f1-b759-52a5204e252b", "name": "Engines", "description": { "content": "Inspect or control the WhatsApp engine(s) connected to the workspace.", "type": "text/plain" }, "item": [ { "id": "08d270a8-fdd9-4fa2-bb64-d2eed99fbde5", "name": "List engines", "request": { "name": "List engines", "description": { "content": "List engines connected to this workspace. Returns an array (currently up to one entry, but the response shape leaves room for multi-engine workspaces). When no engine is connected, `data` is empty and `message` explains why — this is not an error.", "type": "text/plain" }, "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d13f3083-e54c-47cd-be99-4ec5ee762af1", "name": "success", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"data\": [\n {\n \"connected\": true,\n \"state\": \"string\",\n \"stream\": \"string\",\n \"has_synced\": false\n },\n {\n \"connected\": false,\n \"state\": \"string\",\n \"stream\": \"string\",\n \"has_synced\": true\n }\n ],\n \"message\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bdb86a2-f9fa-4339-824d-352dcf9227b7", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2816810e-415b-47ce-a834-bd905edb74ed", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cad884d-ea45-42e0-a756-87a82643f046", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0eea7532-593c-499b-8588-f4a205898f27", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61f14512-b291-4167-bc9e-4b5edd2ba1f1", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d97358c-d2c1-4698-b916-baa0112d9350", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "engines" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c78f113f-e973-4251-8af3-c4ddf3baa571", "name": "Groups", "description": { "content": "Create and manage WhatsApp groups via the connected engine.", "type": "text/plain" }, "item": [ { "id": "1e906bd4-95d4-4a4b-bbd5-24654a095fff", "name": "List groups", "request": { "name": "List groups", "description": { "content": "List the groups the connected WhatsApp engine sees. Supports offset pagination (`limit`+`skip`) and an optional case-insensitive substring search on the group name via `searchToken`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only items whose name matches are returned." }, { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (1-200, default 50)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "db3f7b7a-659e-44b8-ad05-6b24d014b582", "name": "groups", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2007-10-15T03:46:31.842Z\",\n \"last_message_at\": \"1990-12-18T02:02:42.932Z\",\n \"participant_count\": 9943,\n \"announce\": true,\n \"restrict\": true,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": true,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": true,\n \"name\": \"string\"\n }\n ]\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2000-02-02T07:19:57.840Z\",\n \"last_message_at\": \"1955-12-03T17:08:44.385Z\",\n \"participant_count\": 9507,\n \"announce\": true,\n \"restrict\": true,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": true,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": true,\n \"name\": \"string\"\n }\n ]\n }\n ],\n \"limit\": 4025,\n \"skip\": 7150,\n \"total\": 655\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0de8831f-0c69-4af1-aca9-1e312557689d", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12b89cf8-a087-42f5-8e84-6662785a9aec", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a3fec0c-756a-4746-9360-65b1f607eea0", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04390fff-17a4-4c11-a73b-aef49f074d25", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c235a20-cf25-4aa0-bcb3-501c0ce23b70", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33c3c50b-7586-4751-86d8-86b6a6b68884", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1781427c-9006-4423-869c-256ec3233dc3", "name": "Create group", "request": { "name": "Create group", "description": { "content": "Create a WhatsApp group with the given name and initial participants. Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a024c2c3-d9b1-4798-be4d-7c17eadc59cd", "name": "created", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "802cdef8-abc6-40b6-8a0b-c6400946ce44", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0f3b50a-3af5-464a-a5b8-8dca3c76de5e", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84cde7ff-7419-47f2-8248-3d10f85a6120", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2558a59c-b7f7-4618-998c-235998b98632", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc46070-5f7c-46f2-bfd2-e91309ea763d", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8b7eec1-28cd-4b87-b61c-3e3731741655", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"Q4 Planning\",\n \"participants\": [\n \"+15555550100\",\n \"+15555550101\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ae737c57-bb62-47a8-937f-00e7c67d2fc1", "name": "Get group", "request": { "name": "Get group", "description": { "content": "Retrieve a single group by its `@g.us` id, including its subject, description, and participant list. Requires `groups:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ed2afd9c-4663-4591-b1a1-63e2174855e9", "name": "group", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed34379d-dcbd-4697-9af0-c75b34d61063", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c84079f-3e0b-4ba9-b7c7-0f2535c3425d", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a63447d-ecce-4c50-acda-bcd1174c6845", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bc0f0a8-bbc2-4355-9e7f-009c067390ee", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "219d3ffc-0dfc-4868-a3e4-e1e9ab247fd3", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1400c65c-e324-47db-93c8-3f3abd2a8df8", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9edf8e63-d272-49ca-acff-f1b348839f8c", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aa3ce2a3-0ece-473a-9050-0ce937ce9c41", "name": "Update group", "request": { "name": "Update group", "description": { "content": "Update group metadata. Provide at least one of `name` or `settings`. Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "02f660c1-3866-43ed-a8e2-c13c722d4dbb", "name": "updated", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c022571-b571-41c3-b2a1-aa719b8deb03", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "180c0a2d-683d-42c4-aeae-8245fdd5d1ee", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23f2e689-22da-4242-9ad2-ab0a19d31709", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3574c000-c6c9-4045-a02d-53ad6e4076f6", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4a0575b-bc54-4c63-8b25-434bfef95dde", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "365f9737-3f4e-4334-9588-4a8710d69cb5", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08c628d0-9e26-49e3-a0bd-f21278c8037c", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"settings\": {\n \"announce\": \"\",\n \"restrict\": \"\",\n \"edit_info_admins_only\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9ee7aba5-05e6-473b-8226-6d08c4b17d15", "name": "Add member to group", "request": { "name": "Add member to group", "description": { "content": "Add a participant to the group by chat_id (JID) or phone number in international format (e.g. +14155551234). Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fe1cafe4-680b-4b90-ac79-63d453218840", "name": "updated group", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b33432f8-47ba-48c3-be98-3dead20334eb", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c86110fc-ab7e-4da7-8d8a-8392cd7f4879", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c712bcaa-b36a-41df-a7fd-8e744f5ccef1", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35d1eb39-e941-4706-bf10-bfb666a91837", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90a449ea-1135-41b3-9265-34d29e9e0960", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e8c7f96-495c-4099-bae3-0061150b27d6", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33508020-1057-4f62-9c0d-fd958f1e664a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"chat_id\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e157d9a1-8128-42d8-8df3-c38091a8e4d7", "name": "Leave group", "request": { "name": "Leave group", "description": { "content": "Leave the group as the authenticated identity. Idempotent — succeeds with 204 even if already not a member. Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "218c753c-1dd9-4fff-8f56-11d1b0dae029", "name": "left", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "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": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b4aa25db-d606-4067-ab7d-4d1afa8929e0", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b1c6f4f-0510-44c4-b454-b1a8321f179c", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03bc194f-f2e0-437e-8ac1-fbe939bbec31", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e0449c-7337-43b9-b278-beb14d7b53dd", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56c0900c-b371-427d-8b7b-eb035ef12539", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c22cb057-5eff-45b2-8af0-25dc115f7ba2", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1c53a21-9ef5-4810-8c2b-ffaaab307091", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b559e8ca-f428-40b5-af4c-71ea4f626738", "name": "Remove member from group", "request": { "name": "Remove member from group", "description": { "content": "Remove a participant from the group. Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f420eac0-dcc3-4e3f-b629-f3082eef3e1f", "name": "updated group", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee9a7f9e-3217-479e-8e04-4e5c609f460c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82601af9-8b1e-43ab-ab8f-995d65b6c6fe", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68e86513-97d1-4885-a89f-8b2caa5547fa", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0757c391-3a41-4d61-8f89-fb6fafd55cbe", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01c7f33-5fc2-4467-a768-505d16e3180a", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc7c47c0-e3e6-4f2a-be52-d6fa41b58ab9", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bede02f8-c43d-448f-bb42-9897df94041a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f9ecc99f-a467-4762-a6bc-3798c3ce1e21", "name": "Promote member to admin", "request": { "name": "Promote member to admin", "description": { "content": "Grant admin privileges to a group member. Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "35c358dd-a226-41f9-8865-9bb499b51ff3", "name": "updated group", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30d171d4-dafa-47bb-b036-1d6cc8f71c7f", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ccaa835-3a18-42c7-8c38-7c98b1e4d713", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b08a787-e1fb-4b1e-8d9d-e0be1a25ce8d", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbb70c74-2b74-4f92-bc42-3dd7bad8f9f6", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2d26415-3d2f-456b-9f48-df8eaaa56a2d", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbe38969-70be-4e0d-a4a0-e856188d9d97", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f2f92ce-5fbb-42e7-9ac9-dbfc02aa02c9", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c309a302-4dbd-452e-ace5-a616222f6a43", "name": "Demote admin to member", "request": { "name": "Demote admin to member", "description": { "content": "Revoke admin privileges from a group member. Requires `groups:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "969b14d0-92cf-46f6-b092-e982fcf8ac83", "name": "updated group", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee973f6-ff4e-4085-8a23-64f3b3655f02", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d3b56aa3-9cbc-461e-9f57-32edd6d0cf44", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "176d65a4-6227-4df2-9c9f-b3b6ae2862bd", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec34e1c4-ea84-45d3-b0ee-3a7ab7148ece", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d0afd5-427a-4d30-9493-1e2fef1370fb", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebc25e67-c6bd-47b4-af4b-86a100913674", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "878801c8-691f-4483-a2d8-ec80e7523381", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "members", ":chatId", "admin" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "696cb2c4-bc34-4348-b284-82f0a709a52c", "name": "Set group picture", "request": { "name": "Set group picture", "description": { "content": "Replace the group picture. Provide the image as `file_data_url` (base64 data URL, PNG/JPEG, ≤20 MiB) or `url` (https). You can also upload a file as `multipart/form-data` with a `file` part. Requires `groups:write`.\n\n> In the Body panel, the **Attach a file** control has a content-type dropdown: `application/json` inlines the file as base64 in `file_data_url`, or `multipart/form-data` uploads the raw file — then press **Send**.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "20de1096-2b69-4227-86d9-b99541facedc", "name": "picture updated", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"2003-06-30T00:12:28.449Z\",\n \"last_message_at\": \"2010-07-30T09:10:13.784Z\",\n \"participant_count\": 4511,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chat_id\": \"string\",\n \"is_admin\": false,\n \"is_super_admin\": false,\n \"name\": \"string\"\n },\n {\n \"chat_id\": \"string\",\n \"is_admin\": true,\n \"is_super_admin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "376b9ede-6948-4180-8625-62c7c57a181f", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2644d7be-904d-4dd8-b7a6-b1859a591d85", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce2d95d-5aba-4b8b-a41f-914fc28268cf", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d348ad3b-973a-4d80-a3aa-abce369054eb", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bbb0c3c-04bd-4621-9bf4-d24d8422019c", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea88de1-a86f-4256-a77e-361b0cb59378", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d46bd9d-e8f4-4f0a-9e19-8c3e50a236cf", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id", "picture" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"file_data_url\": \"\",\n \"url\": \"\",\n \"file_name\": \"\",\n \"file_mime_type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8262f430-f0eb-4c8f-abdf-ee4d82ab044b", "name": "Messages", "description": { "content": "Send, list, search, react to, and fetch media for individual WhatsApp messages on the connected engine.", "type": "text/plain" }, "item": [ { "id": "710dc6c9-ab5e-47c7-b6b1-c45b2a6f1f49", "name": "List messages (all chats)", "request": { "name": "List messages (all chats)", "description": { "content": "Offset-paginated list of messages across the whole account. Pass `chatId` to scope to a single chat, or omit it to search across all chats. Supports free-text search (`searchToken`), date range (`since`/`until`), and message-kind filtering (`messageTypes`). Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Optional WhatsApp JID to scope results to a single chat. Omit to search across all chats." }, { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only items whose name matches are returned." }, { "disabled": false, "key": "order", "value": "", "description": "Result ordering. asc = oldest-first; desc = newest-first (default)." }, { "disabled": false, "key": "since", "value": "", "description": "Lower bound (ISO 8601). Only messages with timestamp >= since." }, { "disabled": false, "key": "until", "value": "", "description": "Upper bound (ISO 8601). Only messages with timestamp <= until." }, { "disabled": false, "key": "messageTypes", "value": ",", "description": "Filter to specific message kinds. Comma-separated or repeated. Useful for \"all PDFs\" (`document`) or \"images today\" (`image`). System events (gp2/revoked/newsletter_notification) are excluded by default unless explicitly listed here." }, { "disabled": false, "key": "loadFromPhoneIfNeeded", "value": "", "description": "When the local store is exhausted, fetch older messages from the phone (chrome only)." }, { "disabled": false, "key": "includeMediaContent", "value": "", "description": "Include inline media payload on rows (heavy; default false — use /messages/{key}/media)." }, { "disabled": false, "key": "skip", "value": "0", "description": "Number of messages to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Max messages to return." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "56f41b23-bfc8-4806-8650-a83d76acc874", "name": "messages", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"key\": \"string\",\n \"chat_id\": \"string\",\n \"from\": \"string\",\n \"timestamp\": \"1997-01-20T22:28:09.959Z\",\n \"text\": \"string\",\n \"type\": \"string\",\n \"from_me\": true,\n \"ack\": 4949,\n \"media_url\": \"string\",\n \"caption\": \"string\",\n \"filename\": \"string\",\n \"author\": \"string\",\n \"link_preview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonical_url\": \"string\",\n \"thumbnail\": \"string\"\n }\n },\n {\n \"key\": \"string\",\n \"chat_id\": \"string\",\n \"from\": \"string\",\n \"timestamp\": \"1972-02-26T08:26:34.086Z\",\n \"text\": \"string\",\n \"type\": \"string\",\n \"from_me\": false,\n \"ack\": 687,\n \"media_url\": \"string\",\n \"caption\": \"string\",\n \"filename\": \"string\",\n \"author\": \"string\",\n \"link_preview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonical_url\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n ],\n \"limit\": 4935,\n \"skip\": 9877,\n \"total\": 380\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3aa6c0ad-87f0-4785-9e5d-47c04fbbae5c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d53b4d5c-82d5-41c5-a0dd-0f17b4a8b2d2", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "65cdb95d-293e-4ea5-af52-cbbcdd4ea6a2", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7223e320-cb3b-4aa1-bba0-21646f5b7679", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e077e2-1362-4f36-9831-efb4dafccd06", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27cf81b9-90a9-4777-9120-3525e5644cf5", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "order", "value": "" }, { "key": "since", "value": "" }, { "key": "until", "value": "" }, { "key": "messageTypes", "value": "," }, { "key": "loadFromPhoneIfNeeded", "value": "" }, { "key": "includeMediaContent", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "810dd45b-e098-42da-b611-4699f683436a", "name": "Send message", "request": { "name": "Send message", "description": { "content": "Send a message immediately to a specific chat. The body is the same FLAT shape as `POST /v1/scheduled-messages` minus `to` (derived from the URL path) and `sendAt` (this endpoint is fire-and-forget). Set `type` to `text`, `media`, or `poll`. The dispatch is direct — no DB row is created; the response carries the WhatsApp wire key under `key`. For scheduled or queue-managed sends use `POST /v1/scheduled-messages` instead. Requires `messages:write`.\n\n### Sending media (`type: \"media\"`)\n\nProvide the media **one** of these ways:\n\n- **`mediaUrl`** — a public `https://` URL to the file.\n- **`mediaBase64`** — the file bytes base64-encoded (or a `data:` URL), inline in the JSON body.\n- **Upload a file** — send the request as `multipart/form-data` with the file in a **`mediaFile`** part. See the cURL example below.\n\nIf both `mediaUrl` and `mediaBase64` are present, `mediaUrl` wins. Optional: `mediaFilename` (display name) and `mediaKind` (`image` · `video` · `audio` · `document` · `sticker` · `voice` · `gif`; auto-detected otherwise).\n\n> In the Body panel, the **Attach a file** control has a content-type dropdown next to it. Pick `application/json` to inline a small file as base64 in `mediaBase64`, or `multipart/form-data` to upload the raw file (no 10 MB JSON-body limit) — then just press **Send**. The cURL below is the multipart equivalent.\n\n```bash\ncurl -X POST \"https://api.blueticks.co/v1/messages/120363000000000000@g.us\" \\\n -H \"Authorization: Bearer $BLUETICKS_API_KEY\" \\\n -F \"type=media\" \\\n -F \"text=Here is the file\" \\\n -F \"mediaFile=@/path/to/photo.png\"\n```\n\n### Mentioning contacts\n\nMentions are written **inline in `text`** — there is no separate field. Use `@[Display Name]()`:\n\n```\nHi @[Joni Naor](972544325389@c.us) this is a test\n```", "type": "text/plain" }, "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "de2c9307-21e6-4f28-87ce-1bc8b9ec612c", "name": "sent", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"media\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"document\",\n \"pollQuestion\": \"string\",\n \"status\": \"failed\",\n \"sendAt\": \"1963-10-17T04:54:34.133Z\",\n \"createdAt\": \"2020-06-18T05:58:35.997Z\",\n \"confirmedAt\": \"1976-01-29T22:59:57.012Z\",\n \"receivedAt\": \"1984-08-29T09:38:07.087Z\",\n \"readAt\": \"1979-11-10T23:58:08.345Z\",\n \"playedAt\": \"1988-07-18T18:48:29.331Z\",\n \"failedAt\": \"2012-05-09T01:35:11.334Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c5bf06e-521d-469f-aaab-63ca33d6e888", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "836975cb-704c-466f-9a9c-1d7ab12fde23", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a244d8e1-3667-4a13-bb17-78caec99e0d9", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fea16ef7-eaba-4e35-aea4-bbc58592341f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53bf7f20-2b86-4d53-9aea-ce14462a40f4", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed777aef-0cf2-4484-90c9-25c486d3e6ad", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c59fa252-bc6d-4aab-b4b9-5291172a2021", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2881ea3e-e077-4a1f-ae6b-f2a8e627bf3f", "name": "Get message", "request": { "name": "Get message", "description": { "content": "Fetch a single message by its complete WhatsApp message key. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Optional. Only used to find the message faster — when you pass a bare message id instead of the complete key, `chatId` lets the server rebuild the full key. If you pass the complete `waMessageKey` you can omit it." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5a21d14d-0df9-499a-b9d0-a0b83aab3d29", "name": "message", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"key\": \"string\",\n \"chat_id\": \"string\",\n \"from\": \"string\",\n \"timestamp\": \"1961-04-07T22:42:37.297Z\",\n \"text\": \"string\",\n \"type\": \"string\",\n \"from_me\": false,\n \"ack\": 2138,\n \"media_url\": \"string\",\n \"caption\": \"string\",\n \"filename\": \"string\",\n \"author\": \"string\",\n \"link_preview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonical_url\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5e3616e-ceff-4b39-91b1-762414c27f14", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dcd9383-7143-4c2d-a462-411802419986", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df15f5e1-d540-4e8f-9e45-d9b759e6d3d5", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9409210-8ffa-41e0-8e51-7f1576565f62", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bddbb997-d089-4d1d-863a-ce9c11ddbdd5", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5f1413d-3eec-4dbd-8ca6-b2ac51f7a4b9", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8f80de2-8d04-45db-a8db-ae5257104d01", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a5ae502-75d4-4f10-8425-d3efd421e0b4", "name": "Get message delivery status", "request": { "name": "Get message delivery status", "description": { "content": "Returns the WhatsApp ack value for a sent message: -1=error, 0=pending, 1=server, 2=device, 3=read, 4=played. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Optional. Only used to find the message faster — when you pass a bare message id instead of the complete key, `chatId` lets the server rebuild the full key. If you pass the complete `waMessageKey` you can omit it." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3625f9a5-44f4-45c5-88e2-c389ddc878a2", "name": "ack", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"ack\": 4178\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15349422-fcb4-4073-802f-35aa0330f0c4", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d064c00b-edcc-464b-bd6d-8570217b9da2", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dc06838-43cf-4c59-b3cf-97c9181cf7f8", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bf301b8-ffba-4ef8-ada2-31ccccee1ee9", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31693250-6b38-421f-8bba-15daefd32621", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ab18e94-5fc4-45b8-a404-b743789f87b8", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "061d8c1d-17a6-4536-945f-1c2b49f02675", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "ack", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fd195c5d-07e7-465d-b9fe-665c72c861dd", "name": "React to message", "request": { "name": "React to message", "description": { "content": "Add or replace your reaction to a message. Pass an empty `emoji` string to remove. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Optional. Only used to find the message faster — when you pass a bare message id instead of the complete key, `chatId` lets the server rebuild the full key. If you pass the complete `waMessageKey` you can omit it." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ef6d68ba-74a3-456e-938b-fdfe88349984", "name": "reaction set", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"ok\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5d1545a-c68d-4399-8202-fc7057594aec", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ecc76da-24d6-4dca-91ac-e4aa45767f26", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "499f0d95-345e-45ca-862b-dad739eb1c9d", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fc2df84-7d69-492f-966b-de601a0245db", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af542bb4-27f7-463c-9ec5-cdb7aabbf8aa", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05c31fa1-7b1d-4119-b230-d2623e542b11", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f15ee3-637e-4ff9-9174-c649ebbdd8dd", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "reactions", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"emoji\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4fea151-cdf2-46e6-9046-4bdebf91254f", "name": "Load older messages", "request": { "name": "Load older messages", "description": { "content": "Asks the engine to pull older history from the connected phone for chats that haven`t been fully synced yet. Use this once before paginating with `since` if you need messages older than what`s already cached. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "911cc750-18a8-4c95-8d45-b38bf91fe5ce", "name": "load result", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"total_messages\": 9238,\n \"added\": 8689,\n \"can_load_more\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d30ec71c-2222-4cf4-a184-b025dda0c381", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aadc62a5-ac96-4585-bae3-fd2614bb7239", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3effdb33-783b-4cde-b7c3-3fa40c193034", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00d2f113-066f-41ee-b27c-243994c74933", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f52d91da-0bb4-4f41-a1f5-348539ee3873", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b92e40b0-5237-44a8-924a-c3df23a6c343", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "667fc771-a3b7-4cbf-a6c6-3a7664272981", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3d30a25b-7806-4019-9344-b21beb83aba0", "name": "Get message media URL", "request": { "name": "Get message media URL", "description": { "content": "Returns a hosted URL for the message media without inlining bytes. Faster + cheaper than `media` when the caller can fetch the URL themselves. Same `media_unavailable` semantics. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Optional. Only used to find the message faster — when you pass a bare message id instead of the complete key, `chatId` lets the server rebuild the full key. If you pass the complete `waMessageKey` you can omit it." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "95a8605b-1ac7-4d32-b501-def7148f6eab", "name": "media url", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"url\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa09b2e-bf25-4646-a5f5-559f51154b62", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "508fc436-0280-4897-926a-6215d9b89c5c", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a6f31f9-5c83-4e28-88ae-93a73edb3843", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39f4e2ba-0234-4d1a-bdc5-7c69a7d14742", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe1211da-af43-4075-801e-1d698308e091", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "017fabd6-104a-42b8-88ec-271878bf61cb", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5acede5-91d2-4777-961f-f91bc886838d", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "media_url", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cce2bb78-3810-4df0-a558-1b3ea72f93fa", "name": "Batch get message acks", "request": { "name": "Batch get message acks", "description": { "content": "Get delivery status for up to 200 sent messages in one call. Useful for campaign dashboards / status reconciliation. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e11b2599-d507-4845-ac9b-d8682d4c04ce", "name": "ack data", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"key\": \"string\",\n \"ack\": 4651\n },\n {\n \"key\": \"string\",\n \"ack\": 4613\n }\n ],\n \"limit\": 4510,\n \"skip\": 1990,\n \"total\": 1449\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6648b5b-7f13-4f04-ad6d-77c4321cedcd", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3d4b582-d742-4cf0-bb5f-7fdd84f656b7", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03bff1ef-c000-4c80-b8cc-65615aad5436", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "684a6e87-407d-44bc-a9fc-f9c73695be0a", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8be05c01-e01e-4d84-aede-3e0fc516c697", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0edc5430-f790-4b87-90eb-feb93d39cc61", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "acks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"message_keys\": [\n \"\"\n ],\n \"chat_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4ea8040d-675f-454d-971c-aaa3591fb476", "name": "Get message media", "request": { "name": "Get message media", "description": { "content": "Download the media attached to a WhatsApp message (image, video, document, audio).\nReturns either a hosted URL (`url`) or inline `data_base64`, plus mimetype + filename.\n\nCAVEAT: for own-sent newsletter media (messages you sent to a `@newsletter` chat), the bytes returned are a WA-generated preview JPEG (~7KB) rather than the original you uploaded — WA releases the original blob from memory immediately after the unencrypted upload. The response will include `original_quality:false` when this fallback is in effect; the caller can warn the user or decide to retry from a different source.\n\nRequires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Optional. Only used to find the message faster — when you pass a bare message id instead of the complete key, `chatId` lets the server rebuild the full key. If you pass the complete `waMessageKey` you can omit it." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "508b9725-94b4-4d6b-b17e-b33031022538", "name": "media", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"url\": \"string\",\n \"mimetype\": \"string\",\n \"filename\": \"string\",\n \"data_base64\": \"string\",\n \"original_quality\": false,\n \"media_unavailable\": \"no_media\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f342afc8-ba73-47f7-b3b5-1d6ae22c9b7a", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bca53a6c-2be1-43e5-9958-8b71150050c4", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e34b1db1-3fa2-4cec-aceb-8f8e74478ff8", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8db3b58-6af3-4bc3-9caa-2e6cdb4c1fb8", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2bd2873-7419-4ba6-846f-f4f7761cc070", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6ad171e-a3a3-4bc6-9416-35c60515cd75", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38ef6b46-accb-46ed-b20b-d13f69fd1827", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "waMessageKey", "description": "(Required) The complete WhatsApp message key (`__[_]`), e.g. `false_120363426216988013@g.us_3EB0659D13650092D677AD_188450464616609@lid`." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d1848367-b3a6-4007-8c59-53a03f56eda0", "name": "List pinned messages", "request": { "name": "List pinned messages", "description": { "content": "List the currently pinned messages in a chat. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "755a2636-6a91-480a-9649-ba1e5a1b708f", "name": "pinned messages", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"key\": \"string\",\n \"chat_id\": \"string\",\n \"text\": \"string\"\n },\n {\n \"key\": \"string\",\n \"chat_id\": \"string\",\n \"text\": \"string\"\n }\n ],\n \"limit\": 4093,\n \"skip\": 670,\n \"total\": 8339\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236958e3-8ae0-4050-9029-5f7289edf615", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2f080ca-97db-4863-8cd6-c34b43f99a8d", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d37362b1-83c4-4650-a750-440ffdce9383", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0b20bd8-d801-4f8c-95cd-100fb4961974", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "974270ba-31ff-4985-b63e-be17ab7ffd5e", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cae7083e-c300-40af-982c-26c49b0f403a", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a6f789c8-2b07-497e-a451-78117332a34f", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chat_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chat_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "13590c21-dabb-4c64-b44a-d598455dde95", "name": "Newsletters", "description": { "content": "Create and inspect WhatsApp newsletters (channels) via the connected engine.", "type": "text/plain" }, "item": [ { "id": "332c4809-3ed3-4e20-bce7-03fe7285bbc5", "name": "List newsletters", "request": { "name": "List newsletters", "description": { "content": "List newsletters visible to the connected WhatsApp engine. Offset-paginated via `limit` + `skip`. Requires `newsletters:read` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only newsletters whose name matches (case-insensitive substring) are returned, and `total` reflects the matched count." }, { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (1-200, default 50)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8b69f2ff-3949-4391-befd-3f7509ae740f", "name": "success", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"1982-10-09T20:47:31.919Z\",\n \"subscribers\": 5738,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"1989-11-21T05:48:46.828Z\",\n \"subscribers\": 4103,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n }\n ],\n \"limit\": 9224,\n \"skip\": 5803,\n \"total\": 2435\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88ceeb0c-192d-4723-a017-2ca46dda8839", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79c6c426-1943-4e92-a977-2967cfc776a5", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "088c58da-41f1-4fa4-9c67-c5b531b146da", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "789430f7-5930-41ff-beb6-f90a9377bfd1", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42279680-e3f3-4314-a172-67f6e67a4c31", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59ab515a-0092-4c36-8add-117b3dd33a09", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b8f5de8-992b-4a16-8928-950b5d8c79b0", "name": "Create newsletter", "request": { "name": "Create newsletter", "description": { "content": "Create a new WhatsApp newsletter (channel). Requires `messages:write` scope (newsletter creation shares the messages write budget).", "type": "text/plain" }, "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "63ae5566-dd99-4f6d-8958-f998b37a191e", "name": "created", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"1993-02-27T20:55:46.056Z\",\n \"subscribers\": 858,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "add2d612-cefd-4971-b3ed-0e634ec3a41a", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e5ca1d9-bfaf-49be-91fc-cc34e6dba4cc", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08a80a31-94e4-421f-95d9-87e5e6190bbd", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c7ba996-36e4-45ab-9365-32e1f3ce6a64", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a64fa20b-a7e1-4806-b5e6-18b44cdd246b", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddfdc44a-a42d-4074-99b6-015b4f96cdbc", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "908b434b-4763-43cd-9a7b-ed89f4c6ab1f", "name": "Get newsletter", "request": { "name": "Get newsletter", "description": { "content": "Retrieve a newsletter by its JID. Requires `newsletters:read` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6bd9b503-4b31-4d73-b8af-885b1e398172", "name": "success", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"created_at\": \"1993-02-27T20:55:46.056Z\",\n \"subscribers\": 858,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e17fef1-b370-4d96-9587-bed5fb598d84", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f72ff61-2a7d-4d05-b11a-03e52974e191", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d289143f-fa82-4a1b-a19a-0d6107b037b4", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff3096fb-5a3e-45e3-bd93-a2dac5dc3de9", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58d8b606-6754-4242-8fdd-4ccf4ec18908", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "019c7051-68a8-4252-a68c-513d658e9638", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "991c1174-3805-480e-861b-8596440436b1", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "newsletters", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Newsletter JID, e.g. 12345@newsletter." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c7583bf7-70bd-44a5-b81d-7e7dafe30f3d", "name": "Ping", "description": { "content": "Connectivity probe for the Blueticks API and the account's WhatsApp engine(s).", "type": "text/plain" }, "item": [ { "id": "f287d86a-aba4-442b-95f8-67d1f3078606", "name": "Ping", "request": { "name": "Ping", "description": { "content": "Health and connectivity probe. Confirms the Blueticks API server is live (`api: \"ok\"`) and lists the WhatsApp engines currently connected to this account in `whatsapp_connections`. Each connection is labelled `gateway` (a remote, server-side engine — the Blueticks 24/7 gateway / baileys pod) or `regular` (the user's own WhatsApp Web browser extension). An empty `whatsapp_connections` array means no WhatsApp is connected — this is not an error, and `message` explains it. Requires a valid API key; no scope required.", "type": "text/plain" }, "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e7bc3925-2021-4935-a7ca-850308dc3f2c", "name": "success", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"api\": \"ok\",\n \"account_id\": \"string\",\n \"whatsapp_connections\": [\n {\n \"id\": \"string\",\n \"type\": \"regular\",\n \"connected\": true\n },\n {\n \"id\": \"string\",\n \"type\": \"gateway\",\n \"connected\": true\n }\n ],\n \"message\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06827260-b026-4860-b7e1-64549d7b31ed", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4855731-4772-4fbe-850f-6f8b70ae6e36", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73ae4fbb-acc8-410f-97aa-325395051296", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43f28005-5e13-402d-9124-03062987c7c0", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "be80e258-019a-428a-8825-c521c6450ae9", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c748153-51c1-4d1e-a970-793aab6c5878", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "ping" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "633a4a5b-bb3d-4bd6-80ff-781251fd9e56", "name": "Scheduled Messages", "description": { "content": "Send or schedule WhatsApp messages via the user-messages queue. Each request creates a queued send — set `sendAt` (RFC 3339) to defer delivery, omit it to send immediately. List, retrieve, edit, and cancel queued sends.", "type": "text/plain" }, "item": [ { "id": "1d6b7976-bcc9-44c3-9def-59e93e964805", "name": "List scheduled messages", "request": { "name": "List scheduled messages", "description": { "content": "List messages in the user-messages queue (all sources: API, dashboard, extension), newest first (offset-paginated). Optionally filter by `chatId` and/or lifecycle `status`.", "type": "text/plain" }, "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "chatId", "value": "", "description": "Filter to messages addressed to this WhatsApp JID. Matches the recipient stored on the queued/scheduled doc — for sends to a phone number, the JID is `@c.us`." }, { "disabled": false, "key": "searchToken", "value": "", "description": "Search token; when set, only items whose name matches are returned." }, { "disabled": false, "key": "status", "value": "", "description": "Filter by lifecycle status: `pending` (accepted, waiting), `confirmed` (WhatsApp accepted — has waMessageKey), `received` (double grey tick), `read` (double blue tick), `played` (voice played), `failed`." }, { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (1-200, default 50)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b6bf0c53-541b-43c6-ae5a-b340fa47e24b", "name": "messages", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"poll\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"sticker\",\n \"pollQuestion\": \"string\",\n \"status\": \"pending\",\n \"sendAt\": \"2002-01-29T22:35:52.847Z\",\n \"createdAt\": \"1969-12-23T10:48:10.326Z\",\n \"confirmedAt\": \"1977-01-23T04:10:06.010Z\",\n \"receivedAt\": \"1963-07-02T13:27:13.549Z\",\n \"readAt\": \"1947-05-06T12:43:02.610Z\",\n \"playedAt\": \"1985-01-17T02:18:13.518Z\",\n \"failedAt\": \"1948-07-11T19:58:54.108Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n },\n {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"media\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"gif\",\n \"pollQuestion\": \"string\",\n \"status\": \"played\",\n \"sendAt\": \"2010-06-22T11:25:51.431Z\",\n \"createdAt\": \"2005-03-22T21:37:07.311Z\",\n \"confirmedAt\": \"2024-07-25T13:19:22.882Z\",\n \"receivedAt\": \"1966-07-15T17:10:04.627Z\",\n \"readAt\": \"2026-02-09T17:33:06.520Z\",\n \"playedAt\": \"2013-03-19T14:32:30.635Z\",\n \"failedAt\": \"1974-04-17T14:17:11.184Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n ],\n \"limit\": 3734,\n \"skip\": 4746,\n \"total\": 5525\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9488b31-7c92-4c3a-9236-c787eec2dd79", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80dd61a8-f6b8-4b74-8842-0c6f479ba196", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82527edf-ee99-4912-aa54-e2731c0fb9dd", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46ca484d-dbeb-44e9-a024-c22e9712bcc7", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d972ce95-a753-450c-a44f-72240fca1104", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9f13a74-cb4c-4331-9342-cb2e10b726df", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8e10a18b-247e-468d-9e74-1b35a722144b", "name": "Schedule message", "request": { "name": "Schedule message", "description": { "content": "Send a message via WhatsApp. The body is a FLAT object — set the `type` field to one of `text`, `media`, or `poll`; `type` selects which top-level fields are relevant.\n\n**Variants:**\n\n- `type: \"text\"` — required `text` (1–4096 chars). A rich link-preview card is attached automatically when the text contains a URL. Example body:\n ```json\n {\"type\":\"text\",\"to\":\"+15551234567\",\"text\":\"hello\"}\n ```\n- `type: \"media\"` — provide the media as `mediaUrl` (HTTPS) **or** `mediaBase64` (base64 / data: URL); `mediaUrl` wins if both are sent. The bytes are uploaded server-side and only a URL is sent on to the engine. Optional `mediaKind` (`image` · `video` · `audio` · `document` · `sticker` · `voice` · `gif`; auto-detected when omitted), `text` (caption), `mediaFilename`. Example:\n ```json\n {\"type\":\"media\",\"to\":\"+15551234567\",\"mediaUrl\":\"https://cdn.example.com/x.pdf\",\"mediaKind\":\"document\",\"mediaFilename\":\"receipt.pdf\"}\n ```\n- `type: \"poll\"` — required `pollQuestion` and `pollOptions` (2–12 items). Optional `pollAllowMultiple` (default false). Example:\n ```json\n {\"type\":\"poll\",\"to\":\"+15551234567\",\"pollQuestion\":\"Pizza?\",\"pollOptions\":[\"Yes\",\"No\"]}\n ```\n\nAll variants accept optional `sendAt` (ISO 8601 ≥10s future, ≤365d) and `replyTo` (wire `key` of a prior message to quote).\n\nSee [Sending messages](/docs/messages) for runnable Python / Node / PHP / cURL examples per variant.", "type": "text/plain" }, "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"to\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"sendAt\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0cea1596-4b59-4c08-b7b4-09af62e4c2cf", "name": "Idempotency replay", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"media\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"document\",\n \"pollQuestion\": \"string\",\n \"status\": \"failed\",\n \"sendAt\": \"1963-10-17T04:54:34.133Z\",\n \"createdAt\": \"2020-06-18T05:58:35.997Z\",\n \"confirmedAt\": \"1976-01-29T22:59:57.012Z\",\n \"receivedAt\": \"1984-08-29T09:38:07.087Z\",\n \"readAt\": \"1979-11-10T23:58:08.345Z\",\n \"playedAt\": \"1988-07-18T18:48:29.331Z\",\n \"failedAt\": \"2012-05-09T01:35:11.334Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0fd76c3-a6ac-417a-ad8e-2c850acd1fa4", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"media\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"document\",\n \"pollQuestion\": \"string\",\n \"status\": \"failed\",\n \"sendAt\": \"1963-10-17T04:54:34.133Z\",\n \"createdAt\": \"2020-06-18T05:58:35.997Z\",\n \"confirmedAt\": \"1976-01-29T22:59:57.012Z\",\n \"receivedAt\": \"1984-08-29T09:38:07.087Z\",\n \"readAt\": \"1979-11-10T23:58:08.345Z\",\n \"playedAt\": \"1988-07-18T18:48:29.331Z\",\n \"failedAt\": \"2012-05-09T01:35:11.334Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3297ec6-e115-4f81-90a9-98cf9d4204e9", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6872a30-3318-4132-b763-1a2cb30fee56", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b16d39-c4f2-4474-bd37-0f49800727de", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c99a67b-eaad-45be-b845-625bf3406447", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d92bc2e3-d1a3-4526-941d-45fe5b0750e8", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07139ea6-1b63-4860-b14c-31d362660acf", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "disabled": false, "description": "Optional key for safe retries. Identical bodies with the same key return the original response; differing bodies return 409.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": \"+15555550100\",\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8cc16c65-45eb-4dd3-88e7-13eb3391b2f7", "name": "Get scheduled message", "request": { "name": "Get scheduled message", "description": { "content": "Get the current status of a message by ID.", "type": "text/plain" }, "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "11eeb042-8052-4f45-a0b5-1fd6eb2e48f5", "name": "success", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"media\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"document\",\n \"pollQuestion\": \"string\",\n \"status\": \"failed\",\n \"sendAt\": \"1963-10-17T04:54:34.133Z\",\n \"createdAt\": \"2020-06-18T05:58:35.997Z\",\n \"confirmedAt\": \"1976-01-29T22:59:57.012Z\",\n \"receivedAt\": \"1984-08-29T09:38:07.087Z\",\n \"readAt\": \"1979-11-10T23:58:08.345Z\",\n \"playedAt\": \"1988-07-18T18:48:29.331Z\",\n \"failedAt\": \"2012-05-09T01:35:11.334Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c4d4e7f-29e8-487c-a49f-88d2e359d01f", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0563699-b81f-42f5-9038-cb1965bb1e07", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5a5e110-cbfb-45b4-93f5-22e879962928", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d471e22-903c-4af8-a542-44794515e33b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c4b9cb6-9030-4ca1-8140-64d63cacc1ea", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c243637-fb1c-497b-b7a0-4a04dbc3180d", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73349aae-0075-4e1d-83e6-9f17995da5d8", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "acbf86c6-7e8e-4f03-b192-d246f7e94eea", "name": "Update scheduled message", "request": { "name": "Update scheduled message", "description": { "content": "Edit a previously-queued message that has not dispatched yet. Accepts a subset of `text`, `mediaUrl`, `mediaCaption`, `sendAt` — at least one is required. Returns 400 once the message has advanced past the editable window (status not in `pending`/`sending`).", "type": "text/plain" }, "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9ef87443-0d27-46c1-9646-817369fd22e6", "name": "success", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"key\": \"string\",\n \"to\": \"string\",\n \"type\": \"media\",\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"document\",\n \"pollQuestion\": \"string\",\n \"status\": \"failed\",\n \"sendAt\": \"1963-10-17T04:54:34.133Z\",\n \"createdAt\": \"2020-06-18T05:58:35.997Z\",\n \"confirmedAt\": \"1976-01-29T22:59:57.012Z\",\n \"receivedAt\": \"1984-08-29T09:38:07.087Z\",\n \"readAt\": \"1979-11-10T23:58:08.345Z\",\n \"playedAt\": \"1988-07-18T18:48:29.331Z\",\n \"failedAt\": \"2012-05-09T01:35:11.334Z\",\n \"failureReason\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34ec38c9-05e7-4c71-9398-289ea4ed64b7", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcf8fa48-4c9d-4c3f-b9f7-2f859640c3d5", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "442c2de6-cdf0-4f55-a670-e54b9992062e", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dfdd629-2572-43dc-afda-fb1da9bbab6f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3875dfaa-526b-4e35-8c48-ef0e2aa671e6", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a030263-e111-45dd-8584-7f934aa2ff53", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08aaaf15-601a-4cfb-a056-c6d396cee572", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8e7ba5f6-46b7-4f76-b03a-1cca457a879e", "name": "Webhooks", "description": { "content": "Register URLs to receive signed HTTPS POSTs on Blueticks events.", "type": "text/plain" }, "item": [ { "id": "610a6b74-6808-4ee8-8cd9-df6d61c915a7", "name": "List webhooks", "request": { "name": "List webhooks", "description": { "content": "List webhooks in the workspace.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "skip", "value": "0", "description": "Number of items to skip before the page (default 0)." }, { "disabled": false, "key": "limit", "value": "50", "description": "Page size (default 50, max 200)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "856f9d03-2a93-4c16-ace0-68a6217b408d", "name": "list", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"string\",\n \"status\": \"enabled\",\n \"created_at\": \"1973-09-04T13:57:39.505Z\"\n },\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"string\",\n \"status\": \"enabled\",\n \"created_at\": \"1956-06-16T22:25:00.775Z\"\n }\n ],\n \"limit\": 8422,\n \"skip\": 9913,\n \"total\": 7779\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "394c9d57-21fe-4e82-966f-1cee05e8eeed", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41170626-3754-4559-9ecc-04063d4c029f", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3b43961-5bd0-4401-a3af-c983f852983a", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "daab445d-b6e8-4e1c-90cc-2a896535b9b9", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eee5bf1-a460-4641-be3f-cb2fb72046c7", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e883d851-6b16-4d1f-af7b-a481d25ed596", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b001a9bd-09dc-4e38-8bef-eedc06610544", "name": "Create webhook", "request": { "name": "Create webhook", "description": { "content": "Register a new webhook. Returns the signing secret exactly once.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "27351523-5a63-4847-a73f-7738228ed8ca", "name": "created", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"string\",\n \"status\": \"enabled\",\n \"created_at\": \"1971-04-08T15:36:28.961Z\",\n \"secret\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f825c1c-3fca-4709-9ae8-71e50ab4e3a7", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ba80af0-25f5-4c8a-82e6-366f223b6cc8", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db499618-0664-4123-baf0-78b28f6ab18c", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a5b4a7c-9f06-4f75-b293-64c70b157756", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72445dd8-94b0-4e92-a513-a480938ed1f2", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "446d1ec6-086c-4099-bce2-5f2bda9be32a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhooks/blueticks\",\n \"events\": [\n \"message.queued\",\n \"message.sending\",\n \"message.delivered\",\n \"message.read\",\n \"message.failed\"\n ],\n \"description\": \"Delivery lifecycle stream\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "721fadd7-6560-4f53-91f7-a13ffde4d0ff", "name": "Get webhook", "request": { "name": "Get webhook", "description": { "content": "Get a webhook by id.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e227d360-1f1b-4986-8506-49cb244921a5", "name": "webhook", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"string\",\n \"status\": \"disabled\",\n \"created_at\": \"2022-01-29T21:16:09.981Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14c54c18-28e0-4dfa-a639-30da063ee49b", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98e04c25-1380-4393-b366-94d74bbd92d4", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0db0d4a1-bdb5-4922-b139-630396f68d40", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14256cd6-01c8-45ec-bdcb-380d6609717f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d3788b4-482e-4b3e-8393-f1daafc3ddc5", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41e20feb-bbd0-4448-8b71-2c704e0411cd", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cf752b0-5200-4a4a-a532-75a89da97eee", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d2700aca-e0da-48f2-85ee-229c8362ae83", "name": "Update webhook", "request": { "name": "Update webhook", "description": { "content": "Update a webhook.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1548a5d2-d7f3-4a01-b479-41b247ff2399", "name": "updated", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"string\",\n \"status\": \"disabled\",\n \"created_at\": \"2022-01-29T21:16:09.981Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a557e24-1f9f-4333-9640-afef496119bb", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48f0544d-bb52-4eb2-b967-615996c32744", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70cfb8c8-cf66-472f-b3b8-4e8fde524937", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e642d8-f5e5-4b82-ba2d-1a62883554bb", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7de8b32-a95b-4070-baa2-aed7582064fa", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e849e5e8-c02a-4c40-a4b1-f8311b118cda", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e91a5815-f4f5-47df-888b-f6d120d9bc36", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"status\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a949a8b7-d288-44b2-a805-6c16359e45fc", "name": "Delete webhook", "request": { "name": "Delete webhook", "description": { "content": "Delete a webhook.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "71615553-7a0e-4924-ba76-1272449e79c8", "name": "deleted", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"deleted\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2dca6c0-5c4b-4faa-baef-78a8626b75ad", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4275aab-9c45-405a-a85e-acebc184bbf3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04edc887-c786-404c-8a8b-927620e2ecae", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c614aaf-3a4b-40d9-86a2-77be99c29dba", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0567a735-044e-4b8d-8020-098324817fcb", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e391e497-28cf-42a5-b362-f8faaea640bb", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fb0d380-6e1f-4a7b-acf8-25ec5edc5172", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "45f62f06-4e37-4e5e-b669-c8efdcf845ad", "name": "Rotate webhook secret", "request": { "name": "Rotate webhook secret", "description": { "content": "Rotate the signing secret. Returns the new secret exactly once. Requires `webhooks:write` scope.", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b1513cf0-e24b-4600-a72a-397a03365289", "name": "new secret", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"description\": \"string\",\n \"status\": \"enabled\",\n \"created_at\": \"1971-04-08T15:36:28.961Z\",\n \"secret\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31664e85-5707-4623-b336-953584ff16ab", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a786523-6834-4899-b548-95f9562e03c4", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ec772c1-96c0-4c77-9d58-cc9402117bc5", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a0aabf7-7ba5-4f19-b465-4ca9831c239e", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ba81021-e25d-4235-86f2-4d8d6706d9a7", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c60d6e59-0703-427a-b4be-344d6504f7e3", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0468f4b-9012-4eaa-9ba6-89b63c5fb1ef", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"request_id\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const apiKey = pm.environment.get('apiKey') || pm.collectionVariables.get('apiKey');", "if (apiKey) pm.collectionVariables.set('bearerToken', apiKey);" ] } } ], "variable": [ { "type": "string", "value": "https://api.blueticks.co", "key": "baseUrl" } ], "info": { "_postman_id": "e63c467f-fb83-4518-85d4-acf9c916bc01", "name": "Blueticks API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Auto-generated from openapi.json. Import a Blueticks Postman environment (Production or Staging) alongside this collection, paste your API key into the env's `apiKey` field, and every request authenticates automatically.\n\nNeed a key? Generate one at https://www.blueticks.co/dashboard." } }