{ "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": "aed2b739-9654-4811-acac-cdd118a09c5d", "name": "Account", "description": { "content": "Account metadata for the authenticated API key.", "type": "text/plain" }, "item": [ { "id": "011fc22f-c471-4f8d-b1f0-ada38b7eab5b", "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": "7f2c3410-c891-45a4-96e0-56f6735511c9", "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 \"createdAt\": \"2008-12-14T05:18:22.456Z\",\n \"userEmail\": \"string\",\n \"timezone\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02b2499d-2601-44f8-b527-9cda3a535c8d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c70e356-ce3f-4cdb-9fa8-e0a10e6bdfef", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79193ef5-6d5e-44c0-bc4a-2d1e4180a43f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e97ad7d-9aaf-42c4-9d5f-28bdfc8cb62d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a29e25-e708-47f5-bbf2-3ca71d0d6f8d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0867cbec-a396-47f9-982a-90da053334bc", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "eb5efca4-3ee1-4f82-a1b2-56da2f2f81de", "name": "Audiences", "description": { "content": "Reusable contact lists used as targets for messages and campaigns.", "type": "text/plain" }, "item": [ { "id": "e9428e98-ae23-4ab5-8124-061d330e20c2", "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": "order", "value": "desc", "description": "Sort direction by timestamp: `asc` (oldest first) or `desc` (newest first, default)." }, { "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": "adaace44-ca06-44b5-861e-611be263ff02", "name": "audiences", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"contactCount\": 2923,\n \"createdAt\": \"1975-08-28T09:42:27.851Z\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"contactCount\": 7547,\n \"createdAt\": \"1971-08-16T00:26:51.560Z\"\n }\n ],\n \"limit\": 7003,\n \"skip\": 7569,\n \"total\": 6721\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7feaebb6-7ed8-4130-8d82-0367d29200ae", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd757eec-469d-43f6-94e9-566d1eef7206", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31e10be0-899e-4616-b670-3e7113c6bf8d", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee733152-10a6-46c7-99b7-9fe92eeeffb9", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dc52d2a-80fb-449e-9dd7-7c1e84982916", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa7423c9-f168-419c-84cc-6bf88bce88d7", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "audiences" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "97fc64fe-93e7-49ba-8211-bb20d7dc0c76", "name": "Create audience", "request": { "name": "Create audience", "description": { "content": "Create a new audience. Returns the audience with `contactCount: 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 }\n },\n {\n \"to\": \"\",\n \"variables\": {\n \"key_0\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e6c76da8-0465-454f-82d9-e0ab34b900b4", "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 \"contactCount\": 1784,\n \"createdAt\": \"1988-02-19T13:57:15.846Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "155c3744-a5c8-47bb-b278-3e8e645d1048", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8022b090-6236-4864-a34a-4a551be15c05", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "604cc1d0-c63c-47c0-85e1-606fc48fe7f6", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e8c5810-d642-478f-88d4-b6d52f5f9458", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bf10b19-525d-4fae-9f3a-5b371fe46919", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c5eb396-83aa-4918-a909-797c236ff780", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "b8458dbb-27d2-4b71-9240-873d1792b57a", "name": "Get audience", "request": { "name": "Get audience", "description": { "content": "Retrieve a single audience by id, including its `contactCount` 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": "10e224b0-4d22-49ec-8338-a4fb23a5deaf", "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 \"contactCount\": 1784,\n \"createdAt\": \"1988-02-19T13:57:15.846Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "543ccd75-409e-4c80-afdf-c70c52955aa1", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0eaceb3-1f8b-482c-9717-ce4d2c04d705", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38dc130d-929c-4762-9e2d-bf689a493ae3", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad48d0b5-bfbd-4117-a2ce-14db65d6b67d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34406600-255f-415c-b9cc-a63be58ab310", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1007234b-b04d-4db1-810b-c10d5349c325", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88970115-5bd2-4ac2-a0e2-11ef37cb0a00", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "9ef9cd3e-6354-4f05-a250-817c13cae343", "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": "8d628b5b-ebef-4214-aae0-95be3c6767fc", "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 \"contactCount\": 1784,\n \"createdAt\": \"1988-02-19T13:57:15.846Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8026571e-0046-4a07-95fa-117a0adc6d89", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aefd7432-dfd9-4d4d-ad91-82382dfd7231", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66d19f3c-937e-4601-8fb2-591df27e10ec", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "486f4372-600a-4c83-a2a1-8fd96d12b798", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57304e6b-fdc7-4444-bb53-23a4a49ae4c0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1765fd2-72e7-400e-8d84-e2ac1014ae4d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aaaf13ed-a154-4e50-b2ac-42bf9226277c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "a51d692b-b1d6-454c-9c5e-e19419d280ca", "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": "18df80c1-c82a-46de-9089-fcc9c3e79a97", "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": "9e14c17e-c5c2-44dc-9cb6-64bc19131ed2", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97a33ae7-395f-458b-9f71-fa274ddb8ee1", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9271701a-159f-4a9a-a533-e24d33610151", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb17eeaa-94a6-4bbd-ab3e-e43376448acb", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b2fdfed-05f9-4abf-ad22-9bb503ba7a3a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c461f92-7711-40c8-9d9e-84406438dacf", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c49460bb-d6a5-4201-b243-c03b7e92faa2", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "0c2ab422-e784-46c9-8301-ee67494c85a5", "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 }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "188c9ed9-5a40-4a19-b410-83bbe470d765", "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\": 9569,\n \"contactCount\": 2107\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "816ffe9e-e1c1-4c2d-9d0b-7e7e8da446f5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b284d22d-1fc0-4e99-af3a-4224c2e5c59f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa30297e-04c3-4c74-89b9-223b2cdb5269", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b476ed2-6efb-423f-8e8d-23e20749263d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "841486d0-9f1c-4ec5-baee-17eb12b526fe", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa668041-adc7-4f2d-9ebf-3aa6d3fe65ce", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fbd806e-37bf-4065-b70c-96c19050c6c9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "4a4901e6-8d8a-47b5-8622-459ca3af3c68", "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": "2f2f0479-f0bf-4ef8-8772-d3a136f50da2", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"addedAt\": \"1993-12-26T05:59:35.324Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2cc2745-ea6a-48c2-90b7-a575fd9612f3", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7edaa66e-6de8-451c-bfab-5acc531a2e67", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b6116e9-a75b-4c82-bafb-18ff6ff471be", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d877d1e0-4dd0-4c65-9832-9cd6f40b73d9", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3736eb-5199-4191-921c-22fe02d91819", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a036a819-3191-4660-b567-c84b7cbc2084", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d153d29-ebcb-43df-80cd-6b567bf2c40d", "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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\",\n \"key_4\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "71737735-37f2-4ca1-af1c-20aff2df9d0b", "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": "a9fbdd25-483b-42dd-bda6-dc84ede01917", "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": "000d70ad-8e3c-4fc1-b791-a2ea66015e2c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "132461a1-48e2-4de6-a141-5aa9f1e1739b", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8385bc1f-ee23-465c-9631-7cefcab3aa02", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab84cb6a-fc43-4f88-842c-64a66d07058f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "df46ae50-c5b0-4043-aea8-24d8b9965d46", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08233ca1-c94b-495b-8be8-c5ebf3eacab6", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa81e732-b419-4921-875a-57f7c44066c1", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "a33ce409-6b0c-45df-b5ce-1e319d576598", "name": "Boards", "description": { "content": "AI-managed memory boards (Tasks, Leads). Each board is a normal Blueticks board with an AI agent config; items are board tasks with status/priority cells plus AI dedupe/provenance metadata.", "type": "text/plain" }, "item": [ { "id": "dde397f6-6754-4ba9-bd85-fe29a35a2bdd", "name": "List boards", "request": { "name": "List boards", "description": { "content": "List boards, newest first. Filter by `domain` or `agent_managed`. Requires `boards:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "order", "value": "desc", "description": "Sort direction by timestamp: `asc` (oldest first) or `desc` (newest first, default)." }, { "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": "3ef21ae1-0b3d-4a42-95b2-25154ccf70be", "name": "boards", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"board_id\": \"string\",\n \"name\": \"string\",\n \"agent_managed\": true,\n \"web_url\": \"string\",\n \"created_at\": \"1971-05-10T02:39:57.674Z\",\n \"updated_at\": \"1991-02-17T00:57:29.477Z\",\n \"domain\": \"string\",\n \"memory_retention_days\": 7189,\n \"item_count\": 8172\n },\n {\n \"board_id\": \"string\",\n \"name\": \"string\",\n \"agent_managed\": true,\n \"web_url\": \"string\",\n \"created_at\": \"1958-02-06T07:36:22.194Z\",\n \"updated_at\": \"1971-04-28T16:48:04.325Z\",\n \"domain\": \"string\",\n \"memory_retention_days\": 9960,\n \"item_count\": 1890\n }\n ],\n \"limit\": 6172,\n \"skip\": 9434,\n \"total\": 6988\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88261fb9-e756-4c8a-a448-d69462dfdcc9", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3701aaad-ae2b-4a3f-9d10-4590a5036b1a", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de4093f3-fa13-45da-a9b7-15c5b4191f7e", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aca92f83-95dd-4111-a975-f98d7bfa4e57", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6519fc1a-318e-4a78-b6f1-69cc4fd4ac72", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3de69a2b-8ee1-4198-ba8e-e303e2e413a6", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "cb0e83b6-b15e-4cbc-8c4e-35e7a7a29962", "name": "Create or find board", "request": { "name": "Create or find board", "description": { "content": "Find-or-create the agent memory board for (`agent_id`, `domain`). Returns the existing board if one exists, else provisions it from the domain template. Requires `boards:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"\",\n \"entity_kind\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"agent_id\": \"\",\n \"memory_retention_days\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "69798606-77d1-4e11-9326-6a136897d43d", "name": "board", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_ID\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"board_id\": \"string\",\n \"name\": \"string\",\n \"agent_managed\": true,\n \"web_url\": \"string\",\n \"created_at\": \"2026-07-05T12:12:59.463Z\",\n \"updated_at\": \"1988-09-29T18:49:48.742Z\",\n \"columns\": [\n {\n \"column_id\": \"string\",\n \"title\": \"string\",\n \"type\": \"string\",\n \"options\": [\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n }\n ]\n },\n {\n \"column_id\": \"string\",\n \"title\": \"string\",\n \"type\": \"string\",\n \"options\": [\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n }\n ]\n }\n ],\n \"domain\": \"string\",\n \"memory_retention_days\": 9192,\n \"item_count\": 7044\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f907a86-d3ae-4360-b1db-a23ae8f68955", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "deb31452-f0bc-4701-9d19-3969448375ec", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34660cf4-c3e8-4d9f-8a2c-583a318d5ce5", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387123ad-ba15-4f79-8140-1188c88cd8ec", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2ef9897-e850-47fc-afbf-467345de8391", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c52b62e-1411-490b-9a4e-38dc4ab6a141", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards" ], "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 \"domain\": \"tasks\",\n \"agent_id\": \"btgpt:USER_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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "9c6ac12c-09bc-4a7a-84e8-0d3c484d45c4", "name": "Get board", "request": { "name": "Get board", "description": { "content": "Retrieve a board with its columns, options and item count. Requires `boards:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards", ":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": "8fbfee3a-94d0-47f0-835b-877dc29c3d3c", "name": "board", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"board_id\": \"string\",\n \"name\": \"string\",\n \"agent_managed\": true,\n \"web_url\": \"string\",\n \"created_at\": \"2026-07-05T12:12:59.463Z\",\n \"updated_at\": \"1988-09-29T18:49:48.742Z\",\n \"columns\": [\n {\n \"column_id\": \"string\",\n \"title\": \"string\",\n \"type\": \"string\",\n \"options\": [\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n }\n ]\n },\n {\n \"column_id\": \"string\",\n \"title\": \"string\",\n \"type\": \"string\",\n \"options\": [\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n }\n ]\n }\n ],\n \"domain\": \"string\",\n \"memory_retention_days\": 9192,\n \"item_count\": 7044\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9ed7819-3d37-4cba-a8f9-5cdd17ca410e", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7422e37d-7e31-439b-b371-3945a2b8d9a6", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "227f9fa2-39a5-403c-be9e-ca8ffcda6c96", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed1c59a8-e734-4b26-8cbb-1432b14555b7", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66cc6b70-1fd7-4346-8448-b9a3c5270a76", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9620ef57-9420-4f4e-b13a-9cdc14ca5073", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "968b2407-9e0c-4deb-a98f-26e9e83251a7", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "027e0935-1a57-4420-bbfc-50d22adcc97d", "name": "List board items", "request": { "name": "List board items", "description": { "content": "List a board's items (tasks). Pass `active_only=true` to return only items updated within the retention window whose status is non-terminal (the AI's \"active memory\" view). Filter by `status` label or `updated_since`. Requires `boards:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "status", "value": "", "description": "Filter by denormalized status label." }, { "disabled": false, "key": "order", "value": "desc", "description": "Sort direction by timestamp: `asc` (oldest first) or `desc` (newest first, default)." }, { "disabled": false, "key": "active_only", "value": "false", "description": "When true: only items updated within the retention window whose status is non-terminal and not deleted." }, { "disabled": false, "key": "updated_since", "value": "", "description": "ISO 8601 / epoch-ms cutoff; only items updated at or after this time." }, { "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": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9498fef9-4ee8-48a3-9640-3618d062c8b5", "name": "items", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"1966-10-22T23:43:34.562Z\",\n \"updated_at\": \"1961-07-13T21:39:34.725Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 6009\n },\n \"confidence\": 5829.0089172734415,\n \"last_seen_at\": 2885\n },\n {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"2017-02-22T08:31:59.350Z\",\n \"updated_at\": \"1997-10-16T11:32:55.640Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 9430\n },\n \"confidence\": 7364.761979238772,\n \"last_seen_at\": 9046\n }\n ],\n \"limit\": 8709,\n \"skip\": 6241,\n \"total\": 7325\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c9afaa-29cd-4a75-b3e4-b40a4d38c35e", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21c844d8-9d8b-4c22-abae-c71f3c76fea7", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d9e3d25-717c-490e-9857-a5a9196658b1", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93390b6b-148c-42bf-8216-23183575ecee", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "562effa2-7d14-437d-877e-eb2eec340e3d", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8127737e-fcf0-421e-84f9-70a48edd40f4", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "438c895a-b5e8-4802-89f8-34d722a49880", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "key": "active_only", "value": "false" }, { "key": "updated_since", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "50" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "7ac77cc6-e347-477d-98f7-0d1ad666dda3", "name": "Create board item", "request": { "name": "Create board item", "description": { "content": "Create one item. `status`/`priority` are given as LABELS and resolved to the board's options server-side (unknown label → 422 with the valid labels). Dedupe fingerprint + provenance are stamped into aiMeta. Requires `boards:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "db1ddc9f-2967-498f-8c2a-72e968e4cac4", "name": "created", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"2009-07-27T06:43:00.142Z\",\n \"updated_at\": \"1950-07-12T16:25:49.122Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 9796\n },\n \"confidence\": 9863.719641924135,\n \"last_seen_at\": 8068\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f097ff67-e688-44b0-aa94-d354e8bb5570", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f48583b6-1c59-4b95-80cd-1016cf19d13b", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "841a8c2c-c271-4ea3-8325-1dde2bb274c5", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aff1e1d5-4249-4e23-9803-25534fe667ee", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b61c405-5561-4029-af7b-1b20d0f89851", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16838879-e7ad-4a13-a0f3-eec98745d02a", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dba56034-c415-41f4-aee1-aaa34cd61ce4", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "c8f5635c-82b2-4209-918f-596c409d3cd7", "name": "Update board item", "request": { "name": "Update board item", "description": { "content": "Update cells, soft-delete (`deleted:true`) or restore (`deleted:false`) an item. `note` is recorded in aiMeta.history. Requires `boards:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "71be46b2-341c-49b2-a54b-ee22418536d3", "name": "updated", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"2009-07-27T06:43:00.142Z\",\n \"updated_at\": \"1950-07-12T16:25:49.122Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 9796\n },\n \"confidence\": 9863.719641924135,\n \"last_seen_at\": 8068\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87a99164-4c37-4ea9-9621-0d231c32527f", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9322d779-9904-4aaa-80ba-d9bd7fd67c79", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0c23aae1-4706-4465-b102-75bd3d3acf3e", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83763a37-ee9b-45a0-ae34-2b6a0cae3ef5", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49dfd6db-afb3-49d5-a547-671c5e3e554c", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a4be923-1a70-4f4e-a0bf-47bba92724dc", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e071b56-0b37-48b8-a6a7-9c556bc3f852", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", ":itemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "description": "(Required) " }, { "disabled": false, "type": "any", "value": "", "key": "itemId", "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 \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"deleted\": \"\",\n \"note\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "d8bfd27a-a622-4da0-9aee-e219c715a859", "name": "Bulk upsert board items", "request": { "name": "Bulk upsert board items", "description": { "content": "Create or merge many items in one call. Each item is fingerprinted and matched against the board's existing items — a match is patched (merging richer fields, bumping last-seen), a miss is created. Keeps scan-merge token cost flat. Requires `boards:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "67df605f-80b1-435c-a5f3-18f42efd94bd", "name": "merge report", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"created\": [\n {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"1968-01-25T14:59:19.833Z\",\n \"updated_at\": \"1975-08-22T07:48:57.217Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\",\n \"key_3\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 3643\n },\n \"confidence\": 6893.142610948353,\n \"last_seen_at\": 8945\n },\n {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"2010-01-18T22:42:51.002Z\",\n \"updated_at\": \"2016-10-16T23:56:41.039Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 2275\n },\n \"confidence\": 2621.041536334212,\n \"last_seen_at\": 6619\n }\n ],\n \"updated\": [\n {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"1967-02-07T02:43:25.556Z\",\n \"updated_at\": \"1989-10-11T17:58:08.497Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 2558\n },\n \"confidence\": 599.8108949104264,\n \"last_seen_at\": 6683\n },\n {\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"web_url\": \"string\",\n \"created_at\": \"1948-05-20T19:56:58.897Z\",\n \"updated_at\": \"1985-01-21T08:48:13.080Z\",\n \"status\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"priority\": {\n \"label\": \"string\",\n \"bgcolor\": \"string\"\n },\n \"due_date\": \"string\",\n \"cells\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"source\": {\n \"chat_id\": \"string\",\n \"chat_name\": \"string\",\n \"message_key\": \"string\",\n \"excerpt\": \"string\",\n \"extracted_at\": 7759\n },\n \"confidence\": 2739.65695341603,\n \"last_seen_at\": 6196\n }\n ],\n \"unchanged\": 7372,\n \"board\": {\n \"board_id\": \"string\",\n \"name\": \"string\",\n \"web_url\": \"string\",\n \"description\": \"string\",\n \"domain\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c24bffee-5f22-4d8b-977e-a08c6e169faa", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3726eedb-ca72-437e-81b6-d7c4051a8717", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ace8782a-e04b-4daf-befa-4cab7abf172a", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ca576fa-e7f7-4e8c-9896-78dd6848e485", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599df91f-226c-48cc-833f-a80aa697d210", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22bf5b58-0800-4b8b-a032-15e7bdcf7da5", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "049f7b3c-1ff4-4f11-9468-0aacbe98bf10", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "bulk" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"items\": [\n {\n \"text\": \"\",\n \"status\": \"\",\n \"priority\": \"\",\n \"due_date\": \"\",\n \"cells\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"chat_id\": \"\",\n \"chat_name\": \"\",\n \"message_key\": \"\",\n \"excerpt\": \"\",\n \"extracted_at\": \"\"\n },\n \"confidence\": \"\",\n \"allow_duplicate\": \"\"\n }\n ],\n \"mode\": \"upsert\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "1cb10782-610d-417c-aec9-3e94fed06f39", "name": "Find similar board items", "request": { "name": "Find similar board items", "description": { "content": "Server-side dedupe: match each candidate text against the board's items by normalized fingerprint + fuzzy token overlap, returning match pairs (and the misses). Use before creating to avoid duplicates. Requires `boards:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "99722c6c-69aa-43df-83dc-2ee18f4d4a96", "name": "matches", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"matches\": [\n {\n \"candidate_index\": 1403,\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"score\": 8999.903094414283\n },\n {\n \"candidate_index\": 2460,\n \"item_id\": \"string\",\n \"text\": \"string\",\n \"score\": 6136.929124029611\n }\n ],\n \"misses\": [\n 3976,\n 8095\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7444ad4-17c3-41c9-9227-a75bb76c72db", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf9da2b3-67b6-4e80-a30f-f844e8637863", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed62663-64b7-44d1-85aa-cb5def3abad0", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e39d6cd3-0033-4c90-be85-b57f33fc7b1d", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0021bfa9-d056-4413-aabf-1f99e050676b", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f627001b-f891-408e-8ae4-3e8861c58308", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d76336dc-454c-4895-80e1-13a88ae146d3", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "boards", ":boardId", "items", "find-similar" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "boardId", "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 \"candidates\": [\n {\n \"text\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "7802a80c-f3f5-4190-88b6-b27766ed6474", "name": "Campaigns", "description": { "content": "Schedule audiences for paced bulk delivery with pause/resume/cancel controls.", "type": "text/plain" }, "item": [ { "id": "efbac66d-5fe3-40df-b67e-ea16316c358a", "name": "List campaigns", "request": { "name": "List campaigns", "description": { "content": "List the campaigns in your workspace, newest first, each with its live counters (`sentCount`, `deliveredCount`, `readCount`, `failedCount`). Offset-paginated via `limit` + `skip`. Requires `campaigns:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "order", "value": "desc", "description": "Sort direction by timestamp: `asc` (oldest first) or `desc` (newest first, default)." }, { "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": "9c502a1e-fc02-421e-9845-221d4e5b6c17", "name": "campaigns", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"running\",\n \"totalCount\": 1643,\n \"sentCount\": 3872,\n \"deliveredCount\": 2246,\n \"readCount\": 5448,\n \"failedCount\": 5510,\n \"createdAt\": \"1970-05-16T07:38:17.345Z\",\n \"startedAt\": \"1982-03-10T15:54:48.206Z\",\n \"completedAt\": \"1954-07-03T02:02:56.988Z\",\n \"abortedAt\": \"1995-11-07T11:37:41.788Z\"\n },\n {\n \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"pending\",\n \"totalCount\": 6858,\n \"sentCount\": 7211,\n \"deliveredCount\": 9809,\n \"readCount\": 3286,\n \"failedCount\": 2781,\n \"createdAt\": \"1995-03-07T01:38:53.659Z\",\n \"startedAt\": \"2019-03-02T02:32:16.389Z\",\n \"completedAt\": \"2001-02-12T16:22:40.216Z\",\n \"abortedAt\": \"1998-08-11T23:37:31.845Z\"\n }\n ],\n \"limit\": 4378,\n \"skip\": 2989,\n \"total\": 6652\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7ab804f-61ac-4ceb-a1f8-269ef87e0959", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32f7fa13-4395-47e0-b23f-93ab1fbdfdf6", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac76ea61-34ed-4abd-acce-61d66afae4e4", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7736a329-bdc0-40d0-bb4f-34d517f1bbbb", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c4decc8-e588-4854-88cc-97dcc0a2531c", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41901e56-4af3-4eff-a470-6ba3cae89cc6", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "e4b67daa-fa00-43e0-a263-324621b74021", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "66281a64-7ca7-4e28-aade-b9acf43c343d", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"pending\",\n \"totalCount\": 4121,\n \"sentCount\": 8288,\n \"deliveredCount\": 6113,\n \"readCount\": 6948,\n \"failedCount\": 7483,\n \"createdAt\": \"1997-01-22T05:40:24.345Z\",\n \"startedAt\": \"1975-07-20T05:16:05.341Z\",\n \"completedAt\": \"2004-08-08T17:02:41.933Z\",\n \"abortedAt\": \"1987-05-05T01:39:22.152Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d5b56943-432c-42d3-ae16-9afdb16804bf", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba3c8959-3047-4ae7-a0ef-a57e05901bc8", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e50cfc0e-ed55-4d87-b8bd-1b27c18ed1c1", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "074a82da-42b5-4c9d-a7b4-5379f7afecbe", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f993bc0-cac7-44ad-bac0-cfbed43c4a4b", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a375d21-ad67-482f-b8b3-b4074e6e9f6a", "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 \"audienceId\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaCaption\": \"\",\n \"onMissingVariable\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "3ca2b5d6-60c0-49cc-8bbd-d1b5fede3b0b", "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": "1dfefc56-061e-4ddd-a498-5bd00edfa539", "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 \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"pending\",\n \"totalCount\": 4121,\n \"sentCount\": 8288,\n \"deliveredCount\": 6113,\n \"readCount\": 6948,\n \"failedCount\": 7483,\n \"createdAt\": \"1997-01-22T05:40:24.345Z\",\n \"startedAt\": \"1975-07-20T05:16:05.341Z\",\n \"completedAt\": \"2004-08-08T17:02:41.933Z\",\n \"abortedAt\": \"1987-05-05T01:39:22.152Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8f0fa8a-1132-4fc0-ab87-698e90dbc3d3", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93c0b59f-5974-4b5a-b242-5339587da1ee", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5613b531-46dc-4445-9864-1a9c29abf12e", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d69d555-efaa-4793-be02-a9f4df1579ed", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18007548-7ab6-4468-bfb4-f48a3f1ccdb3", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fad330fb-d375-45fb-bf59-9cf4333fec09", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fa05b51-baf3-4e4c-ae39-6cccdd4a5b91", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "23f89a63-0071-4bd0-87a0-2ec5add85dc1", "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": "663d6abf-993b-4d0b-a51f-5b676f46287e", "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 \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"pending\",\n \"totalCount\": 4121,\n \"sentCount\": 8288,\n \"deliveredCount\": 6113,\n \"readCount\": 6948,\n \"failedCount\": 7483,\n \"createdAt\": \"1997-01-22T05:40:24.345Z\",\n \"startedAt\": \"1975-07-20T05:16:05.341Z\",\n \"completedAt\": \"2004-08-08T17:02:41.933Z\",\n \"abortedAt\": \"1987-05-05T01:39:22.152Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af0b734d-7f5b-41a9-9742-8c9c4e69ab9e", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3286add-e9b7-492b-b553-316b5fedfef8", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "647f99a3-97ca-4809-91a5-916e9de8720c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "892dbd12-e76f-441c-a34b-8b5f8350f3e6", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2da492c-9fd9-4c24-bb9b-c978d88f133d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7d47968-3aca-441c-ad2d-4d4c1ab61984", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "676b5134-981d-4be4-bb32-55f57ad3e7ef", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "7603bc4f-a18f-42a7-9a53-96d9e04109da", "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": "a09715a8-ad63-46c0-932c-9175c113a8fd", "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 \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"pending\",\n \"totalCount\": 4121,\n \"sentCount\": 8288,\n \"deliveredCount\": 6113,\n \"readCount\": 6948,\n \"failedCount\": 7483,\n \"createdAt\": \"1997-01-22T05:40:24.345Z\",\n \"startedAt\": \"1975-07-20T05:16:05.341Z\",\n \"completedAt\": \"2004-08-08T17:02:41.933Z\",\n \"abortedAt\": \"1987-05-05T01:39:22.152Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c2a670-6f87-4cc9-ba97-fa4272b74e9b", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bbaabe1-2c6e-4ad2-8e72-343cb1c8af66", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03e3e794-caf7-4cc4-82cf-91e5a657a16a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a79a4175-52ec-489c-abcf-d5adeca28fed", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c865971-f18f-43a5-9c84-0326cbe50628", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a478e21-f654-4525-9802-58c0832f365d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e87b6030-4981-4cfc-afd3-ad137f8d8433", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "3b49606e-eeff-4b3e-a9fb-41b528e93a22", "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": "c444d7e9-1c62-4bb9-806a-03a7a4dfcbde", "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 \"cmpId\": \"string\",\n \"name\": \"string\",\n \"audienceId\": \"string\",\n \"status\": \"pending\",\n \"totalCount\": 4121,\n \"sentCount\": 8288,\n \"deliveredCount\": 6113,\n \"readCount\": 6948,\n \"failedCount\": 7483,\n \"createdAt\": \"1997-01-22T05:40:24.345Z\",\n \"startedAt\": \"1975-07-20T05:16:05.341Z\",\n \"completedAt\": \"2004-08-08T17:02:41.933Z\",\n \"abortedAt\": \"1987-05-05T01:39:22.152Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c67240ee-e62c-401b-acc6-b69c6e099dbc", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eee5464a-d7d8-4781-b59b-505ca7af3aa0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25482f6c-d4be-452a-a47a-ef9d75d4bb3f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ed7ded-d85e-4e36-aa3b-3c30d86330c0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "feb5b486-6f9d-4a18-97c7-6a2064db23f1", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51414114-662d-46dd-9c23-b91e0e860ee9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf0b6eb7-2086-4286-b101-c85b34f87321", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "bd68fd7b-0926-4e9f-a193-7a7f074f5204", "name": "Chats", "description": { "content": "Read and manage WhatsApp chats on the connected engine.", "type": "text/plain" }, "item": [ { "id": "05761e58-9b61-4c3d-aea7-3c7801d17f7d", "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": "kinds", "value": "", "description": "Keep only these chat kinds (INCLUDE semantics). Comma-separated or repeated." }, { "disabled": false, "key": "since", "value": "", "description": "Keep only chats whose last message is at/after this ISO 8601 instant (offset allowed; approximate — see sinceApplied)." }, { "disabled": false, "key": "includeLastMessage", "value": "", "description": "Include the last message snippet on each chat row." }, { "disabled": false, "key": "includeExtendedInfo", "value": "", "description": "Include extended chat metadata (engine-side opt-in)." }, { "disabled": false, "key": "includeWithoutName", "value": "", "description": "Include chats with no resolved name (default: skipped)." }, { "disabled": false, "key": "includeArchive", "value": "", "description": "Include archived chats (default false → archived excluded)." }, { "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": "5444d7b5-0eb0-4835-8974-751bfd4e854d", "name": "chats", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"chatId\": \"string\",\n \"chatType\": \"group\",\n \"markedUnread\": true,\n \"name\": \"string\",\n \"pinned\": false,\n \"archived\": true,\n \"lastMessageAt\": \"2008-10-30T03:04:45.919Z\",\n \"unreadCount\": 830,\n \"lastMessageText\": \"string\",\n \"lastMessageFromMe\": true\n },\n {\n \"chatId\": \"string\",\n \"chatType\": \"newsletter\",\n \"markedUnread\": false,\n \"name\": \"string\",\n \"pinned\": true,\n \"archived\": false,\n \"lastMessageAt\": \"1987-01-06T08:39:05.389Z\",\n \"unreadCount\": 8113,\n \"lastMessageText\": \"string\",\n \"lastMessageFromMe\": false\n }\n ],\n \"limit\": 4105,\n \"skip\": 5374,\n \"total\": 74\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "894ba2da-32ce-430b-98bb-4a4da17ddaf0", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86de5612-2a01-432a-8d36-ba81defe03e0", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d06e37c-47be-4c37-8047-c8269a038341", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "237c3453-889a-49a6-8f7a-1b9bda9c5b61", "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": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853f89d9-bb53-454c-96d5-ea3d902a4044", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "035c05b9-45a5-4bb0-a36d-be988addd36a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "filter", "value": "" }, { "key": "kinds", "value": "" }, { "key": "since", "value": "" }, { "key": "includeLastMessage", "value": "" }, { "key": "includeExtendedInfo", "value": "" }, { "key": "includeWithoutName", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "35a73576-0b5c-4f3f-b0ed-d90b397a8b43", "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": "5fcbfb1b-004b-492d-b4eb-4a552e6cc2e1", "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 \"chatId\": \"string\",\n \"chatType\": \"contact\",\n \"markedUnread\": true,\n \"name\": \"string\",\n \"pinned\": true,\n \"archived\": false,\n \"lastMessageAt\": \"1958-04-16T01:25:42.389Z\",\n \"unreadCount\": 2768,\n \"lastMessageText\": \"string\",\n \"lastMessageFromMe\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17a72a3c-07cf-4d51-9212-125bcc6cd526", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d28687e-fe31-40dc-9b7e-07c509c35ee5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a69446aa-ecdb-44c3-911b-2915d5529207", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd4574ea-eebc-46ab-b385-5c33b568ca80", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecb12306-14c9-4b4d-92ef-1939857236ae", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40859e8d-6e2e-4985-b07d-8e7eda64888d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f818fde6-dc0b-471d-bca1-e2df431ecb27", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "00802918-85ec-4e76-a1a3-a67ff4311fa7", "name": "Get latest chats & messages", "request": { "name": "Get latest chats & messages", "description": { "content": "Returns the most-recent non-archived chats (pinned first), each with its latest messages (newest-first). One call — no per-chat round-trips. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "numberOfChats", "value": "50", "description": "Total chats to return, pinned first then most-recent (1-200, default 50)." }, { "disabled": false, "key": "numberOfMessages", "value": "20", "description": "Latest messages to include per chat, newest-first (0-100, default 20)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e37b25d5-3ba8-401e-bf75-4b3fdd0d549c", "name": "latest chats with messages", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"chats\": [\n {\n \"chatId\": \"string\",\n \"chatType\": \"newsletter\",\n \"markedUnread\": true,\n \"messages\": [\n {\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": false,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"2007-07-05T11:06:39.678Z\",\n \"text\": \"string\",\n \"ack\": 6220,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n },\n {\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": false,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"1994-10-01T11:12:32.603Z\",\n \"text\": \"string\",\n \"ack\": 4481,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n }\n ],\n \"name\": \"string\",\n \"pinned\": true,\n \"archived\": false,\n \"lastMessageAt\": \"2015-03-27T15:18:48.256Z\",\n \"unreadCount\": 5404,\n \"lastMessageText\": \"string\",\n \"lastMessageFromMe\": true\n },\n {\n \"chatId\": \"string\",\n \"chatType\": \"contact\",\n \"markedUnread\": false,\n \"messages\": [\n {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": true,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"2013-12-25T08:38:36.898Z\",\n \"text\": \"string\",\n \"ack\": 7210,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n },\n {\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": true,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"1955-10-03T05:16:28.210Z\",\n \"text\": \"string\",\n \"ack\": 1811,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n }\n ],\n \"name\": \"string\",\n \"pinned\": false,\n \"archived\": false,\n \"lastMessageAt\": \"1963-04-22T11:24:26.348Z\",\n \"unreadCount\": 1182,\n \"lastMessageText\": \"string\",\n \"lastMessageFromMe\": false\n }\n ],\n \"totalChats\": 4958,\n \"numberOfChats\": 7244,\n \"numberOfMessages\": 4146\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc1bf9a5-ea9b-497a-bcb1-721f3e7c9389", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "986332af-98ee-4926-9d76-343db2ca019f", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f6ff93c-f8ca-41e0-b5ee-1b76ddc7fac7", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82b5aef1-ca90-4b84-a3ed-dcdc4bae32eb", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86d08402-f8c5-4889-9da1-95feb6744813", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04904606-a7c7-4af0-982c-c268b1b5ab74", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "latest-chats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "numberOfChats", "value": "50" }, { "key": "numberOfMessages", "value": "20" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "77246642-52bd-4998-a49d-3f9f445a7b69", "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", ":chatId", "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": "chatId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "49ebf161-6846-4023-8246-483ec9580fb1", "name": "participants", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": true,\n \"name\": \"string\",\n \"isSuperAdmin\": true\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": true,\n \"name\": \"string\",\n \"isSuperAdmin\": true\n }\n ],\n \"limit\": 265,\n \"skip\": 5098,\n \"total\": 4751\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424538dc-bdd6-4958-b78e-f0233db3a5c6", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b3afd9f-f03e-4b98-9a1c-fdc3af34442a", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1f7752c-7f47-4760-9920-a9cc46965b53", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "358c9a1a-9c5f-4cac-ac7a-038f0a4b5ec2", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b8490fd-e2fe-405d-ac0d-91ede298ab51", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a050fca3-34b3-4863-b85c-61f2b753a761", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8965536-55f4-4455-b46e-fd46a0bfd28a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "participants" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "skip", "value": "0" }, { "key": "limit", "value": "100" } ], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "dd1166f0-ff55-4040-89d2-81af230ac070", "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", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "f933934d-f8fe-48a4-bb1c-b3c9c33bf0b7", "name": "marked read", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"ok\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3ab74b9-4955-40e8-bd5a-62b36bd13d0c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "069be64a-326c-4fad-a890-75aef208311f", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90ba3dd5-a7a5-4d57-b2aa-43b6f70968df", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbe7057d-7b8e-4c56-a415-915ce3bb1d36", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce31ffa4-8c13-44e2-8280-fe6cc34ba04b", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff990d96-387e-4a87-9b31-d9306007c378", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86899b21-f0b8-4696-bbfc-1f325fec5351", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "mark_read" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "40d2756c-8813-4572-bd5f-f0c4f5a61eab", "name": "Archive chat", "request": { "name": "Archive chat", "description": { "content": "Archives the given chat on the connected engine, hiding it from the main chat list. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "39ca671e-cb9d-45f9-b9c6-f5c165a39b06", "name": "archived", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"ok\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9737f7f-ceed-43ce-9543-9526da2fa408", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfdd7feb-ea00-445d-b587-a8ab6558222b", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbf63647-c4e1-407f-9eaa-0d03ced0887c", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc3379bb-e4f6-4c5a-9451-520cc4614395", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "731ecabb-e584-49cb-96b4-93fbee0035ea", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d2abf52-9692-45c3-a0a5-cfeae9734961", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52e9ab82-94ec-43f6-81af-e295a1b2cc74", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "17ecc892-4a6f-4cc7-a403-52ae567e9e03", "name": "Unarchive chat", "request": { "name": "Unarchive chat", "description": { "content": "Removes the given chat from the archive, restoring it to the main chat list. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "0275b80c-fdb9-4979-903c-7ddcb0d27244", "name": "unarchived", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"ok\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64c1e2c1-284d-4efc-8dfd-2a54934c6f82", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63f63a59-a442-430a-b6c8-7f54ccedcfc4", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33360be9-46aa-447b-9e8c-f4b8612f63d8", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45cad294-d3ca-4283-b5b9-c4a71c1f75f3", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2825c271-e3ee-403c-a112-4f6ad3c3d27d", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fbe887c-d0ae-4081-ab8a-7ab50042dd68", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c7e188-8a3a-42cf-bcf2-50e04fd4edcc", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "chats", ":chatId", "unarchive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "7dc3a06f-1ff0-46bf-84f9-0c117d92a151", "name": "Contacts", "description": { "content": "Read WhatsApp contacts known to the connected engine.", "type": "text/plain" }, "item": [ { "id": "3e41da7c-0212-44ad-b9ca-d9d5c5b58f77", "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": "includeArchive", "value": "", "description": "Include archived chats (default false → archived excluded)." }, { "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": "0d9792f6-3f67-436b-8b85-803aca7942a1", "name": "contacts", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"chatId\": \"string\",\n \"name\": \"string\",\n \"isBusiness\": true\n },\n {\n \"chatId\": \"string\",\n \"name\": \"string\",\n \"isBusiness\": false\n }\n ],\n \"limit\": 3588,\n \"skip\": 8273,\n \"total\": 8034\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c5e557-251e-460f-98b6-0dfdf327a647", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36b74e01-6a74-4eff-add7-4ed8af01eed3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "edfb521c-0a03-4d82-8890-5cdd19c7f787", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc39037-d590-4e7d-ab81-901f7ae75b2a", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03ed4db9-b7dc-47e0-b621-57788737f717", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71be54a2-5ffb-4cc1-8ad6-c2132241b9cb", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "9d61f484-bc41-432b-9ac9-64278ab1692b", "name": "Get common groups", "request": { "name": "Get common groups", "description": { "content": "List the groups the connected WhatsApp account shares with this contact (WhatsApp’s \"groups in common\"). `id` is the contact’s JID (e.g. `12345@c.us`). Returns the same group list-item shape as `GET /v1/groups`. Requires `groups:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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": "8e034df0-49f0-458b-b90f-e1d3de333e6c", "name": "common groups", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"createdAt\": \"1958-07-02T08:02:42.874Z\",\n \"lastMessageAt\": \"1992-12-14T09:43:31.378Z\",\n \"participantCount\": 9178,\n \"restrict\": false\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"createdAt\": \"1986-05-16T09:46:12.137Z\",\n \"lastMessageAt\": \"1956-08-31T13:55:01.200Z\",\n \"participantCount\": 5016,\n \"restrict\": true\n }\n ],\n \"limit\": 8343,\n \"skip\": 6639,\n \"total\": 9963\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47a7378a-72f5-4b21-81d1-c0b68e19a3dd", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f516e10e-5549-45e6-9d16-198d3d3bddd1", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cc6560d-bb8a-4eaf-8c58-7c3906580ce4", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3cf4932-7cff-42c4-92b6-bc35b891df5b", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae6bb2a7-c20c-40c9-bc4e-6c4c41c23f44", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32434514-6b65-479f-97d8-e2b46d47fea6", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eda2735e-1472-44ad-9321-89e4f59206e1", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "contacts", ":id", "common_groups" ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "5ed07726-6dee-4c6b-b1a7-51357f2b08de", "name": "Engines", "description": { "content": "Inspect or control the WhatsApp engine(s) connected to the workspace.", "type": "text/plain" }, "item": [ { "id": "5ffd2b97-3223-4e4b-9d8d-bdf0798a413e", "name": "List engines", "request": { "name": "List engines", "description": { "content": "List the WhatsApp engines connected to this workspace — one entry per online engine (a workspace with two paired WhatsApp Web tabs returns two entries). Each entry carries its own `id` (the engine session's MQTT presence client id, same id space as ping's `whatsapp_connections[].id`), its `type` (`gateway` or `regular`), and its connectivity status. When no engine is connected, `data` is an empty array — 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": "46bb0c9d-c2d0-4bc4-ae9b-2e2669c9f1e6", "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 {\n \"id\": \"string\",\n \"type\": \"gateway\",\n \"connected\": true,\n \"state\": \"string\",\n \"stream\": \"string\",\n \"hasSynced\": false\n },\n {\n \"id\": \"string\",\n \"type\": \"regular\",\n \"connected\": false,\n \"state\": \"string\",\n \"stream\": \"string\",\n \"hasSynced\": false\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ec1b38-80fa-43e1-a45a-acfc8843978c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2251ea63-b799-4d6e-ba22-6366c0813850", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46d47cc8-3791-4132-b33b-2ac1706e88c8", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd2d0489-cbe2-4b24-afe4-4ebd8f71415c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e88a0c73-a4e9-4a12-9d19-9613a98bbde7", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cafb1010-3592-48fc-bc6e-efcba5df1d54", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "ef415e64-b28a-4ee4-a8f8-a1a73b44963b", "name": "Groups", "description": { "content": "Create and manage WhatsApp groups via the connected engine.", "type": "text/plain" }, "item": [ { "id": "98bd210a-ca65-4a3a-afa9-149c7d6fcb7c", "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": "includeArchive", "value": "", "description": "Include archived groups (default false → archived excluded)." }, { "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": "faa2c9b9-494c-47ac-9eed-130d08be40a9", "name": "groups", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"createdAt\": \"1958-07-02T08:02:42.874Z\",\n \"lastMessageAt\": \"1992-12-14T09:43:31.378Z\",\n \"participantCount\": 9178,\n \"restrict\": false\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"owner\": \"string\",\n \"createdAt\": \"1986-05-16T09:46:12.137Z\",\n \"lastMessageAt\": \"1956-08-31T13:55:01.200Z\",\n \"participantCount\": 5016,\n \"restrict\": true\n }\n ],\n \"limit\": 8343,\n \"skip\": 6639,\n \"total\": 9963\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ecaacbb-2e5b-4e2b-8cc5-bec8c5b31846", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e62ed690-0663-4156-81be-351d040bbd36", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ade6369-b437-4e94-8597-83ed0b037295", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "205398e0-bf28-4d8a-95bc-b74477fccf1f", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "399c8780-c054-4eb9-9d9c-51409075a122", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7ac02cd-4cec-4a6f-b560-0088ffc3bdc8", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "33d6b962-e83b-42c3-8b5e-47fb388bbe71", "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": "a3cd7389-92d8-4cee-be37-69e9e788a4b5", "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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9fe44633-93ca-4da5-9b7c-c05c59d6369e", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8af61e6e-79ad-4d95-a79f-3739f504eec5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0484b4e-0d58-43c5-b97b-214789009bd7", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88f1a613-9f47-416b-99c6-509b2486b615", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc3708c5-5fd5-4f2e-8726-99b58360a927", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebed3e98-a62d-4924-965b-109383f28d69", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "e960dc3a-7570-4150-b6d6-e18f5212ee83", "name": "Get group", "request": { "name": "Get group", "description": { "content": "Retrieve a single group by its `@g.us` id, including its subject, description, and (with `?include=participants`) its participant list. Requires `groups:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "include", "value": "", "description": "Set to `participants` to inline the group members array on the response. Omit to leave `participants` null." } ], "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": "13826d56-c6a0-4ffc-be3a-34234d8af275", "name": "group", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c19e129-e586-4f9b-aaa7-38820417e566", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46cc4143-be60-4099-a07a-48efba89107c", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66b930ca-bd8c-490d-ba18-a8185a2bb4f2", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2fb83fee-687f-4466-bb62-6712a3f89742", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8528df79-f7b7-4204-ab62-5793c52de59f", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b893146f-bfec-4440-86be-542095511f3e", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9d7f327-c095-4824-b45c-ecae2cca6b7b", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "groups", ":id" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "include", "value": "" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "875673c3-efe3-476a-815c-7de11f032b12", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6e3d543-8c79-4aa3-bfb5-393e622ecfe8", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "275cf667-c227-4909-8364-017d872efaf0", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38eb0dbc-b2c9-4c93-aaab-5adb14a1cb3b", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d4da135-06eb-4b34-b731-cf70fa75adcb", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c482356-759e-49fc-bfb7-1af10b1732d1", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c52514d3-b554-42f0-8fd0-8bb087587410", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66683bff-ee08-4b93-983d-0b4533dc1ea1", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21a23686-32f3-431b-b8f2-9a82a5d80c7e", "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 \"editInfoAdminsOnly\": \"\",\n \"description\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "a479d80b-f141-484d-bbb7-df86c68564dd", "name": "Add member to group", "request": { "name": "Add member to group", "description": { "content": "Add a participant to the group by chatId (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 \"chatId\": \"\",\n \"participants\": [\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fe2146eb-c405-4e3b-9fbc-e29a149ae7db", "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 \"chatId\": \"\",\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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed136a2-df07-4e57-a563-1f75f2fb00f7", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0ceb6cc-8c7a-4e30-b147-f0a5467d4df8", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15a380df-5320-4a19-b90d-bbff1eee826d", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4a1d819-23f9-4fee-ab66-4eb6a90afa9d", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8627b1a-be1e-4555-a754-7a1b138c3c9a", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fb243ab-92f1-4ba1-9821-bef6331970f6", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "462d4298-70c1-43a2-8252-938f17a8570b", "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 \"chatId\": \"\",\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "03b7726b-efb7-4ed1-844d-af4083752a6a", "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": "da827926-ce23-4679-b34f-6f70d00256a3", "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": "e0fab16e-fcdc-4a7c-8112-987d629f13be", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c48c5215-e6fe-46c0-9876-a0224e2bc90e", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8df0a953-d6f8-4f5e-93bf-6ac39923ae6f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dde5259-dde1-4072-a455-be48688ae402", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4817fa93-0ce5-467c-a5aa-5826e700c94b", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9174afd-7b0e-4759-95e9-e7a33310177d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9464457d-a8c5-4010-afd5-d0882b32d098", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "4b8239bd-6f23-44c7-a558-cd54074930fa", "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": "ba2de8e8-d259-4e5c-a566-b9e3d2a03366", "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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf8a49d0-e0c7-4f11-baf6-fd9219ee0da5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b36bbca-031f-4c1b-9004-c6f4a36105d6", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dda6b2b-836c-4377-a3d1-4a3d8a4f0468", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef63e81a-3829-43a6-895a-d0ae5a3e6bbc", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72d1900a-3131-44ae-b78f-97ca4dd4d0fb", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "135d9ec6-07d1-458d-b764-b2a66af20e06", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb7e3443-c973-491d-8f82-a3f4fdcd41ff", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "c33e2f1e-c9dd-4979-b365-82a30cda574d", "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": "d1b7e946-3144-4f7d-a226-9b33f2bf68ee", "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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e2b1a4c-6e80-48f0-b78f-d64ddac371ad", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38fe6aff-936f-41e8-9c2c-e43b00074009", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b19d809-0687-4fd5-bd65-23462adcf1da", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2154ae5-b6df-4eba-b7ce-0eccf1df83bf", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70ba0a78-4a99-4d1b-9deb-ca1800f78ab0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19e1955a-cfbf-4d17-9351-d8b884f7ff10", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c568db3b-d197-4d4d-b728-718c5f39c7d5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "89e9d542-5e0e-4bd4-a0e6-24a88924ddb1", "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": "f2745048-1650-4844-8a46-9c0573342dbd", "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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "457c9e0d-882e-4afc-951e-88b1438f5016", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "307faf7f-40f2-4191-a46a-703f718ecac9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16efef6d-6fbc-4ad6-b391-0fc1ec6d6d4f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0bc1daa9-8835-4d76-8045-406fda0373e7", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c2a833-fa41-4191-bc67-f9984e8d687a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2236f57-d7a6-449c-98fc-f67e56fb8d32", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8029afd-a8d9-4417-8cd5-9abc744763b4", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "623be824-b086-4887-a17a-06fd2d7ce73d", "name": "Set group picture", "request": { "name": "Set group picture", "description": { "content": "Replace the group picture. Provide the image as `fileDataUrl` (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 `fileDataUrl`, 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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b0f1a041-748f-4d1b-9774-3cbcd93627ed", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"createdAt\": \"1982-04-27T04:46:11.936Z\",\n \"lastMessageAt\": \"2025-04-02T03:32:13.139Z\",\n \"participantCount\": 3508,\n \"announce\": false,\n \"restrict\": false,\n \"participants\": [\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": true,\n \"name\": \"string\"\n },\n {\n \"chatId\": \"string\",\n \"isAdmin\": false,\n \"isSuperAdmin\": false,\n \"name\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82226455-c2c1-47aa-8afc-66ee3038df87", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86e74596-55a1-4f1c-9ffd-4b705be579ac", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d811d8a1-b0b8-4511-991a-6eef4e5a0b58", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4de216e9-3c07-4598-9a14-a9d8fbd53492", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "764d3d23-a7b5-43cc-b2e2-9b2aaf04c229", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b4365bd-5ec3-4333-8bfc-6c782596dcbb", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1456d02f-465f-4544-be4d-3f7109541508", "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 \"fileDataUrl\": \"\",\n \"url\": \"\",\n \"fileName\": \"\",\n \"fileMimeType\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "8f57d590-388e-46ef-b6e6-88e08706037c", "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": "96278764-d810-4a1a-903b-405ca44ca5f1", "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, offset allowed). Only messages with timestamp >= since." }, { "disabled": false, "key": "until", "value": "", "description": "Upper bound (ISO 8601, offset allowed). 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": "queryAny", "value": "", "description": "Keyword-set OR search: match if body/caption/filename contains ANY term." }, { "disabled": false, "key": "queryAny", "value": "", "description": "Keyword-set OR search: match if body/caption/filename contains ANY term." }, { "disabled": false, "key": "mime", "value": "", "description": "MIME prefix filter, e.g. \"application/pdf\" or \"image/\"." }, { "disabled": false, "key": "filenameContains", "value": "", "description": "Case-insensitive substring match on the document filename." }, { "disabled": false, "key": "hasMedia", "value": "", "description": "true = only messages with a media attachment; false = only non-media." }, { "disabled": false, "key": "sender", "value": "", "description": "Case-insensitive substring match on the sender JID/phone." }, { "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": "50cee608-db92-4248-8107-75210b841bc3", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": false,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"1955-11-30T12:27:51.397Z\",\n \"text\": \"string\",\n \"ack\": 5644,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n },\n {\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": true,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"1947-05-20T18:53:39.942Z\",\n \"text\": \"string\",\n \"ack\": 6597,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n }\n ],\n \"limit\": 415,\n \"skip\": 4444,\n \"total\": 4320,\n \"hasMore\": false,\n \"coverage\": {\n \"oldestLoadedTimestamp\": 1342.31046012242,\n \"oldestLoadedIso\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22d4e598-40e7-4352-8ef3-bb754ceb409c", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72118634-8f91-42a1-b3a9-d0861d610c89", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd157b65-85a3-4fa9-854f-e142ad4ca763", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "742e19c9-c880-4b37-a085-d49a3054f1cb", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcad4df1-fe96-4d49-93ff-ecf98f53cd55", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f64dcdd-cd1f-43b5-a50a-4ef34c1791db", "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": "queryAny", "value": "" }, { "key": "queryAny", "value": "" }, { "key": "mime", "value": "" }, { "key": "filenameContains", "value": "" }, { "key": "hasMedia", "value": "" }, { "key": "sender", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "a08d19ef-8a27-4fdb-9361-67d6b4ede1ef", "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 @[Jon Daw](xxxxxxxxxxxx@c.us) this is a test\n```", "type": "text/plain" }, "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chatId", "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 \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c6dc78cc-beeb-4ac3-8b0a-54850f019676", "name": "sent", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"to\": \"string\",\n \"type\": \"text\",\n \"status\": \"delivered\",\n \"createdAt\": \"1947-05-15T20:16:59.948Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"gif\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": false,\n \"sendAt\": \"2003-08-23T07:43:05.753Z\",\n \"confirmedAt\": \"1952-04-16T18:05:41.009Z\",\n \"receivedAt\": \"1979-06-02T05:04:32.308Z\",\n \"readAt\": \"2016-06-13T18:07:27.260Z\",\n \"playedAt\": \"1999-11-16T06:59:50.396Z\",\n \"failedAt\": \"2009-06-21T21:24:41.985Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83118b38-2e70-4634-bfb4-77f92a572e04", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e50b17e-932c-416c-b0b4-f80902c687bb", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de7814b8-f2a9-44e4-a4b0-4b8d3f3ef72a", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1118934e-0ea9-4b8b-930b-4f6ace900e2c", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dfc7bcd-5eaf-4576-9b7d-a1fff89ca980", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f4db2d7-1185-4fde-b48c-4b5980a1f9e8", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bf8079b-5a22-460a-87b4-f8f556c2db5d", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"type\": \"\",\n \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"withTyping\": \"\",\n \"typingSeconds\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "33b9ee23-8edd-4f41-8ec7-19c242135d70", "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": "6df0e772-71b7-4898-bf57-7699ce1a6c63", "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 \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"chatId\": \"string\",\n \"from\": \"string\",\n \"type\": \"string\",\n \"fromMe\": false,\n \"author\": \"string\",\n \"senderName\": \"string\",\n \"timestamp\": \"1980-09-26T16:37:33.075Z\",\n \"text\": \"string\",\n \"ack\": 9575,\n \"mediaUrl\": \"string\",\n \"filename\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n },\n \"quotedMessage\": {\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"type\": \"string\",\n \"author\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e11c43bd-6932-4c81-93e1-072acafded5b", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eda33b47-6724-4119-add6-40547e312d8d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7abb9630-d10e-41e9-818b-ffed5ec5ba41", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "075dbbea-a5e3-41f1-aca7-d52504c1ae1f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "622331a0-d38c-408a-80dc-88f825b3184f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7007755e-9769-467e-b57b-3bf7cc486ae4", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e01d402-479e-4c3c-8496-561fe8a75eeb", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "605fbd40-7b47-45d1-a986-825c9d820df7", "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": "0d684c23-c902-48b1-99c8-c779391a45b2", "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\": 2524\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cf0c492-03d8-4cda-973a-712909e31523", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1498da88-34d4-40a2-bf2d-facb00008d63", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c14560c5-f464-4c1e-b411-bb124b1c66bc", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18432274-af85-4024-ba8b-76c2ed738899", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "658cf664-58bb-4413-93fa-b370ac9e6ec0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "758efe78-e836-45a2-add2-05ae9318d9c9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74af3e9d-64da-4177-89cd-4e949551805d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "90223c33-df27-43c1-8002-cfd1bc28e29a", "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": "330054bc-536b-44ab-817c-90bc9f5022a9", "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": "b99b4b00-a403-433e-bba5-a92adef769e0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cc14bf0f-95a6-41db-ac35-d62b6bf6ecaa", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71308597-a612-427c-bad1-92ee5c5e3a11", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80f2cec4-4d55-4f2d-8ae6-c1cfd1f2315f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf484ea2-e69f-4e85-a498-16c4dd25380b", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc120608-6cfd-4d76-ab9f-83747c655f20", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf30f86c-ac6e-49e6-b8b9-68b5e9a3786a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "6ce41cfd-d250-4e62-b328-fae78b889991", "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 before paginating with `since` if you need messages older than what's already cached. Optionally pull several pages in one call via `pages` (WA-paced ~2.5s apart) and/or stop at a target depth via `until_date`; the response reports how far back the chat is now loaded under `coverage`. Requires `chats:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chatId", "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 \"pages\": \"\",\n \"until_date\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "aefd5f19-5bbb-47dd-95c2-50fc29d523cf", "name": "load result", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"canLoadMore\": false,\n \"historyUnavailable\": false,\n \"pagesExecuted\": 8804,\n \"coverage\": {\n \"oldestLoadedTimestamp\": 7175.284553049272,\n \"oldestLoadedIso\": \"string\"\n },\n \"totalMessages\": 4759,\n \"added\": 7328,\n \"error\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "083d672e-c488-4ef4-b100-dd6b26c1103c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8b9b0b5-944b-4d3c-9154-34f3523f12c3", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d5afa9a-72b3-43a1-a781-a2d82948c8bb", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe106ed-e68e-4754-aa35-bf77f4890672", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c148e615-c372-403a-9279-b036e6967a67", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33381a1e-3682-4767-8aa1-e53e82a055ac", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f698d41-00c0-49ae-a85b-32f40e70f404", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "load_older", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": { "mode": "raw", "raw": "{\n \"pages\": \"\",\n \"until_date\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "8c952d28-b8c3-46bf-8e26-7ba0fd5bd2ef", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4e17abbd-6399-4bd8-80f3-dc3844e9a854", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"found\": true,\n \"ack\": 4060\n },\n {\n \"key\": \"string\",\n \"found\": false,\n \"ack\": 3375\n }\n ],\n \"limit\": 2406,\n \"skip\": 637,\n \"total\": 3056\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ae500a7-33fd-43ce-9fdc-4269f14f762b", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a24075f-b324-47d2-be87-383f9093004e", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc4359ef-ac81-4608-87aa-848a6e82f8e9", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68be35f6-fbee-4d04-903d-4f200db9b9d3", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58b10b78-ccc1-4778-b2aa-707e3243368e", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a30f3b-55da-4ac5-92f2-d33f8f3f9126", "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 \"messageKeys\": [\n \"\"\n ],\n \"chatId\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "fcd7a4b8-3bdf-4489-a13f-affe16228210", "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 `dataBase64`, plus mimetype + filename.\n\nThe engine fetches media lazily, so the first call right after a message arrives may still be in flight. By default the server polls up to 6 times (1.5s apart) until the bytes are ready. Pass `?maxAttempts=1` to skip the poll and return immediately (the fast path — useful when you only need the hosted `url` and can tolerate a retry yourself).\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 `originalQuality: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." }, { "disabled": false, "key": "maxAttempts", "value": "6", "description": "Optional. Maximum number of engine attempts (including the first) while the media is still being fetched from the phone. Defaults to `6`; pass `1` to skip retries and return immediately. Range 1–10." } ], "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": "f2b2ae08-eabb-42d6-94c4-1031912661cb", "name": "media", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"dataBase64\": \"string\",\n \"originalQuality\": true,\n \"mediaUnavailable\": \"expired\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81c91a7b-8835-4107-9ada-501d005fdc2c", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b388b49-b7b6-4309-873f-31d0a78c42ab", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6414a1b-82d5-4224-b0d1-7a9a7a99801b", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a2ccb1b-36aa-4c45-bd1e-1ff13e4a6961", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "245f5fca-7bdc-4a73-b8b4-1f00072198bd", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b360d180-7b5a-49e2-afff-7ddd3be6238b", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ae8d0ba-011a-486a-9aed-1e6721a48b7a", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "media", ":waMessageKey" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "maxAttempts", "value": "6" } ], "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "33258a13-e141-4695-a6dd-c6bb148a0e3f", "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", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c29e633d-0c6b-4a50-8433-2f49827740d6", "name": "pinned messages", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": [\n {\n \"key\": \"string\",\n \"chatId\": \"string\",\n \"text\": \"string\"\n },\n {\n \"key\": \"string\",\n \"chatId\": \"string\",\n \"text\": \"string\"\n }\n ],\n \"limit\": 1614,\n \"skip\": 510,\n \"total\": 8874\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18983218-05cc-41b8-bfe0-074a7e0cc98f", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ce6a6df-598d-4880-b8aa-f802beb85a10", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3cdee68-a63b-4510-8be9-7938844f3c5b", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9195210-cf6b-4a02-bb76-6ad7b3e08798", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7f09bfd-5bf7-498e-9405-41000208bb3d", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd03743c-264c-40ae-a60a-4a781fe9e9e5", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51fb450a-2eeb-43e8-926b-fc2f56674fc9", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "pinned", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "6d8bba04-760e-4a3e-b10f-16e88babac9e", "name": "Pin message", "request": { "name": "Pin message", "description": { "content": "Pin a message to the top of its chat. Optionally pass a `duration` (seconds) in the body to control when the pin expires — defaults to 7 days. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0053da7a-71b4-44da-a524-3611573a844e", "name": "message pinned", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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": "fa8a2b97-ae04-4389-ad5f-952ccc11a390", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "235e6909-9725-4be8-b704-3595c1b8d7ee", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b881540-c7a3-400a-87be-19f629085c40", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "77a15548-696d-4a6a-a998-2ef41b1453c6", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "251cbf6e-22ef-4b9a-afae-51de8af84433", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf2b5029-253d-479f-836b-6e63daf3fbbd", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a51ab624-1260-4907-b0dd-b29a18dc65eb", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "pin", ":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 \"duration\": \"\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "b277c4e5-478d-4d5c-95ae-1d19063a6d69", "name": "Unpin message", "request": { "name": "Unpin message", "description": { "content": "Remove an existing pin from a message. Requires `chats:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "messages", "unpin", ":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": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7e8c3888-0842-417b-89ca-e27faba64f89", "name": "message unpinned", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "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": "95a689d8-a364-42fe-9b42-ec602c0cbbe5", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f5eea9-6196-4c9c-a9f9-fb95364ac14e", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd0cfe49-66d4-416f-8457-b2ad0a3940bb", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": false,\n \"error\": {\n \"code\": \"string\",\n \"message\": \"string\",\n \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9e6f045-c6c0-49a4-8040-cd16dd29c067", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5a86a3b-f67e-411e-8e7d-c8c2aa75ccfb", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d0426754-d90c-4cc8-87df-e95038facb27", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6c3ea21-1c9e-4770-8176-40f1ca19215b", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "messages", "unpin", ":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": {} }, "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "f4663904-c9e6-404f-9693-e4b578153a21", "name": "Newsletters", "description": { "content": "Create and inspect WhatsApp newsletters (channels) via the connected engine.", "type": "text/plain" }, "item": [ { "id": "177b558c-3903-4d1d-bf75-b634ccc1b04b", "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": "includeArchive", "value": "", "description": "Include archived newsletters (default false → archived excluded)." }, { "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": "2c2a55e9-fb31-4d3a-bab8-c92ee7f35774", "name": "success", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"chatId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdAt\": \"1980-02-27T18:01:19.089Z\",\n \"subscribers\": 6524,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n },\n {\n \"chatId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdAt\": \"1995-06-20T05:37:13.631Z\",\n \"subscribers\": 221,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n }\n ],\n \"limit\": 4710,\n \"skip\": 2419,\n \"total\": 7952\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4880a16-803a-48ce-9211-08a4db7dba92", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "153e8572-ae0d-4139-80f2-26c8931c3e7b", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c954ae0-3975-492d-9a2a-2f185f11f668", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3721113b-aee0-4050-8b87-43e0dc6b5f99", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a9a3eae-992a-4a4f-8eb6-a5780d296efe", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "409f0b31-7c1c-43bb-b7de-a3e06f1f69c9", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "newsletters" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "searchToken", "value": "" }, { "key": "includeArchive", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "afb708a9-13f7-4c33-b645-618ccf348ec6", "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": "495c07e5-37e7-4267-a636-e9d1c79d52b3", "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 \"newsletterId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdAt\": \"1967-01-08T06:00:54.594Z\",\n \"subscribers\": 6472,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d8dd0c9-d723-40f4-9256-752b2fd62d79", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e1b8e99-e63b-49d2-ae8e-583e41cfcb56", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f001cb15-5825-4bec-9c60-76a653626996", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "564cfe2d-852f-47da-ba4b-ed710e7e7ee7", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb66c2c5-f2c3-45d8-aef1-fe7ca7589564", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05b756cd-9131-4bb7-8612-bafd435c3104", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "eff4d53b-a7d9-4afe-b487-728b670f7572", "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": "a09ece91-2737-4447-898b-3a9680e5e6a7", "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 \"newsletterId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"createdAt\": \"1967-01-08T06:00:54.594Z\",\n \"subscribers\": 6472,\n \"invite\": \"string\",\n \"verification\": \"UNVERIFIED\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42a0258f-355d-43c5-8d33-2320a92a20af", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31b1829e-c81a-416f-9291-a0ebf35eda8d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322d0e04-b77e-462a-8147-d9fa6304656d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ac3b4ca-fa8c-48fd-8e8c-51e5fc318d5f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f45b527e-04af-4c74-9834-9407c2ae0a08", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "154f4896-66ef-4be0-8407-bcc0504bb2e4", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a36d6347-45db-4bf0-b7a7-c97286d105e5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "50379d03-769b-4777-90c4-0465952b7804", "name": "Ping", "description": { "content": "Connectivity probe for the Blueticks API and the account's WhatsApp engine(s).", "type": "text/plain" }, "item": [ { "id": "4c13f225-e0e9-44da-95b0-32b83df825aa", "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 `whatsappConnections`. 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 `whatsappConnections` 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": "6c069b96-3f6d-4f96-bb68-203bbf9e32cf", "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 \"accountId\": \"string\",\n \"whatsappConnections\": [\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": "fca8cc97-343e-4b18-bd53-ca339a4a5c61", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "686b8119-e72c-45c1-8a20-f96f57bf086a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bae615a8-dfe9-4b33-8f01-0585d5245bb2", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c15e12e7-ed20-4d4b-b5b9-0c00c43ce592", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a01e34c0-e287-472e-a2e2-b0e946e667ff", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "babf2361-9969-44da-8872-21e3e53b1990", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "d1da90d9-1c08-4699-8fc4-2520c10ea345", "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": "769eb6e9-fc60-46d0-8af0-4e2175104179", "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": "order", "value": "desc", "description": "Sort direction by timestamp: `asc` (oldest first) or `desc` (newest first, default)." }, { "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": "0730fdd4-281e-49b6-80fb-098b7c5e2bab", "name": "messages", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "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 \"to\": \"string\",\n \"type\": \"text\",\n \"status\": \"confirmed\",\n \"createdAt\": \"2015-05-06T06:55:32.773Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"voice\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": true,\n \"sendAt\": \"2010-02-28T04:10:18.351Z\",\n \"confirmedAt\": \"1965-06-06T23:55:06.525Z\",\n \"receivedAt\": \"2024-10-12T14:44:07.001Z\",\n \"readAt\": \"2020-08-15T04:48:46.324Z\",\n \"playedAt\": \"1982-03-04T04:54:53.506Z\",\n \"failedAt\": \"2020-04-09T19:21:14.862Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n },\n {\n \"to\": \"string\",\n \"type\": \"media\",\n \"status\": \"failed\",\n \"createdAt\": \"1964-12-21T19:30:14.099Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": true,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"document\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": false,\n \"sendAt\": \"1974-03-24T08:26:21.239Z\",\n \"confirmedAt\": \"2008-10-16T13:23:58.271Z\",\n \"receivedAt\": \"1969-02-26T08:52:46.737Z\",\n \"readAt\": \"1987-02-24T07:57:55.704Z\",\n \"playedAt\": \"1963-03-10T18:48:42.915Z\",\n \"failedAt\": \"2005-05-30T09:12:26.126Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n ],\n \"limit\": 9232,\n \"skip\": 8344,\n \"total\": 476\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a2e99d-c934-4dcf-979f-6eab62ea69ae", "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": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "625e71b0-7f4c-4241-b6d0-d16cdf055fc5", "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": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b32ff1f-8ebd-44b9-a9b0-ccc587201a5d", "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": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e0197a4-2cd2-4781-aed1-009e9502042b", "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": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78acfeb0-2b3b-4ace-b4cf-4ced79be5442", "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": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d3a844c-6d6b-4f45-a402-d7ff9b4b442e", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "chatId", "value": "" }, { "key": "searchToken", "value": "" }, { "key": "status", "value": "" }, { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "c394b985-0302-4de7-b4ec-1869c76eee54", "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": "d351c222-8ff5-4bcc-8766-5934f13fdcb9", "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 \"to\": \"string\",\n \"type\": \"text\",\n \"status\": \"delivered\",\n \"createdAt\": \"1947-05-15T20:16:59.948Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"gif\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": false,\n \"sendAt\": \"2003-08-23T07:43:05.753Z\",\n \"confirmedAt\": \"1952-04-16T18:05:41.009Z\",\n \"receivedAt\": \"1979-06-02T05:04:32.308Z\",\n \"readAt\": \"2016-06-13T18:07:27.260Z\",\n \"playedAt\": \"1999-11-16T06:59:50.396Z\",\n \"failedAt\": \"2009-06-21T21:24:41.985Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5c88e3c-7385-4c10-b2a3-de1809df07c9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ea297d7-c26a-4d0a-b126-d4c956ad4cc5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd5120dc-fdfb-4839-a726-71d3feb5b08a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8957e9c-1a17-4161-861b-06d0c6a3c69c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f7994db-9dac-46d9-9c30-fc02f3c7d668", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1220789c-f259-494b-83f1-b4d2eb03fbea", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f87470b8-6e21-4936-950b-0a6742b3d046", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "92de0a5f-34c7-4856-9365-b21fa3ae6530", "name": "Update scheduled message", "request": { "name": "Update scheduled message", "description": { "content": "Edit a previously-queued message that has not dispatched yet (status `pending`).\n\nAccepts the **same flat body fields as [Schedule message](#schedule-message)** — `type`, `text`, `mediaUrl`, `mediaBase64`, `mediaKind`, `mediaFilename`, `pollQuestion`, `pollOptions`, `pollAllowMultiple`, `sendAt`, `replyTo`, `secret` — but **every field is optional**. Send only the fields you want to change; at least one is required. The recipient is fixed at schedule time (it was the `{chatId}` path param) and cannot be changed here.\n\nNotes:\n- A new `mediaUrl` / `mediaBase64` is re-hosted to GCS just like on create; `mediaKind` / `mediaFilename` can be edited on their own.\n- Editing `text` re-derives the link-preview card (auto-attached when the text contains a URL).\n- `sendAt` reschedules (must be ≥10s in the future, ≤365 days).\n- Returns 400 once the message has advanced past the editable window (status not `pending`).", "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 \"type\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"sendAt\": \"\",\n \"replyTo\": \"\",\n \"secret\": \"\",\n \"pollQuestion\": \"\",\n \"pollAllowMultiple\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a889c618-f421-4fa6-b1d6-e15c6ff7ded1", "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\": \"Updated reminder: meeting moved to 4pm\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"to\": \"string\",\n \"type\": \"text\",\n \"status\": \"delivered\",\n \"createdAt\": \"1947-05-15T20:16:59.948Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"gif\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": false,\n \"sendAt\": \"2003-08-23T07:43:05.753Z\",\n \"confirmedAt\": \"1952-04-16T18:05:41.009Z\",\n \"receivedAt\": \"1979-06-02T05:04:32.308Z\",\n \"readAt\": \"2016-06-13T18:07:27.260Z\",\n \"playedAt\": \"1999-11-16T06:59:50.396Z\",\n \"failedAt\": \"2009-06-21T21:24:41.985Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f79fa03-d70e-4526-a309-fc79226f5c74", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2a3bd2b1-9cf4-401b-8b5a-a2a2ee2f1375", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a4093df-bf11-4736-a8ce-28b560f888df", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a295d471-3be7-41b7-b2f4-6b44b7d4f43b", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09cfda40-815a-462b-a882-e308b4223fde", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dfb52a8-d83b-46f7-9c3a-33f85739032c", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf634ada-9d8f-45f3-90d2-89be50da79e7", "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\": \"Updated reminder: meeting moved to 4pm\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "3ee8e858-d660-4f26-b709-c4c5276d59be", "name": "Delete scheduled message", "request": { "name": "Delete scheduled message", "description": { "content": "Delete a scheduled or queued message so it will not be sent. Soft-deletes the message (and records a cancellation in its delivery log). Returns 404 if no pending/queued message with this id is owned by the caller.", "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": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "96b2507d-df7e-4d11-834a-4a3c3767926f", "name": "deleted", "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": "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": "7883cd41-4c2d-4c85-a9b7-cb1fff6ee98f", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6c43c40-61ec-43e7-b142-84db7f87fbcc", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33f193a4-f82f-4491-b70b-3e2feb513792", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "939d26bc-17e7-4ef8-81ff-b9fdcbbaa3d2", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f20ddd5d-7efe-4f57-8222-cbf7b398ac26", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "790a12dc-7f5d-45d9-983c-f1a62d9356fb", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8330953-14dc-4fc4-ab28-fd4fc900cf14", "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": "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "fbd656f9-6867-44b9-bf83-5b243980ea8a", "name": "Schedule message", "request": { "name": "Schedule message", "description": { "content": "Send or schedule a WhatsApp message to the chat named in the URL path (`{chatId}` — a phone number in E.164 format, e.g. `+15551234567`, or a WhatsApp chat id like `12345@c.us` / `1234567890@g.us` / `12345@newsletter`). Omit `sendAt` to send immediately; set it (RFC 3339, ≥10s and ≤365d in the future) to defer delivery.\n\nThe 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:\n ```bash\n curl -X POST \"https://api.blueticks.co/v1/scheduled-messages/+15551234567\" \\\n -H \"Authorization: Bearer $BLUETICKS_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\"type\":\"text\",\"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`. You can also upload a file as `multipart/form-data` with the bytes in a `mediaFile` part.\n- `type: \"poll\"` — required `pollQuestion` and `pollOptions` (2–12 items). Optional `pollAllowMultiple` (default false).\n\nAll variants accept optional `sendAt` (defer) and `replyTo` (wire `key` of a prior message to quote). Pass an `Idempotency-Key` header to make retries safe (at most one send per key). Requires `messages:write`.\n\nSee [Sending messages](/docs/messages) for runnable Python / Node / PHP / cURL examples per variant.", "type": "text/plain" }, "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "chatId", "description": "(Required) " } ] }, "header": [ { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "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 \"replyTo\": \"\",\n \"text\": \"\",\n \"mediaUrl\": \"\",\n \"mediaBase64\": \"\",\n \"mediaKind\": \"\",\n \"mediaFilename\": \"\",\n \"pollQuestion\": \"\",\n \"pollOptions\": [\n \"\",\n \"\"\n ],\n \"pollAllowMultiple\": \"\",\n \"secret\": \"\",\n \"sendAt\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "541b3bc9-7a37-43b0-8bd9-4ff545b9d2d1", "name": "Idempotency replay", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"to\": \"string\",\n \"type\": \"text\",\n \"status\": \"delivered\",\n \"createdAt\": \"1947-05-15T20:16:59.948Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"gif\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": false,\n \"sendAt\": \"2003-08-23T07:43:05.753Z\",\n \"confirmedAt\": \"1952-04-16T18:05:41.009Z\",\n \"receivedAt\": \"1979-06-02T05:04:32.308Z\",\n \"readAt\": \"2016-06-13T18:07:27.260Z\",\n \"playedAt\": \"1999-11-16T06:59:50.396Z\",\n \"failedAt\": \"2009-06-21T21:24:41.985Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb9cd504-4dcb-43f3-b336-14ca00ef2832", "name": "Created", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"to\": \"string\",\n \"type\": \"text\",\n \"status\": \"delivered\",\n \"createdAt\": \"1947-05-15T20:16:59.948Z\",\n \"id\": \"string\",\n \"waMessageKey\": {\n \"fromMe\": false,\n \"remote\": \"string\",\n \"id\": \"string\",\n \"_serialized\": \"string\",\n \"participant\": \"string\"\n },\n \"text\": \"string\",\n \"mediaUrl\": \"string\",\n \"mediaKind\": \"gif\",\n \"pollQuestion\": \"string\",\n \"pollOptions\": [\n \"string\",\n \"string\"\n ],\n \"pollAllowMultiple\": false,\n \"sendAt\": \"2003-08-23T07:43:05.753Z\",\n \"confirmedAt\": \"1952-04-16T18:05:41.009Z\",\n \"receivedAt\": \"1979-06-02T05:04:32.308Z\",\n \"readAt\": \"2016-06-13T18:07:27.260Z\",\n \"playedAt\": \"1999-11-16T06:59:50.396Z\",\n \"failedAt\": \"2009-06-21T21:24:41.985Z\",\n \"failureReason\": \"string\",\n \"secret\": \"string\",\n \"linkPreview\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"canonicalUrl\": \"string\",\n \"thumbnail\": \"string\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3ad5d23-c483-436f-9960-347523016465", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f96e6b5b-e96d-476f-be2e-582e978a4d62", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd703c76-3d49-4dcb-8582-a839732341d0", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c924c6ac-d6b4-4273-9060-422712f4709f", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"text\",\n \"text\": \"Hello from Blueticks!\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c71cf81-c896-42d8-bec2-1f11a52b679b", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16e84662-cf06-4f37-befc-e6e9a325ccf2", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff56b72b-34af-4793-ab68-bbbf6204a1d0", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "scheduled-messages", ":chatId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "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 " }, { "disabled": false, "description": "Optional key for safe retries — guarantees a request runs at most once, so a network timeout + retry never double-sends. Reuse the same key to retry: an identical body replays the original response (HTTP 200 instead of 201, no second message); a different body with the same key returns 409 Conflict. Keys are scoped per workspace (max 64 chars). This is the request-level dedup control — distinct from the body `secret` field, which is only a correlation tag and does NOT prevent duplicate sends.", "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "27cd0b2f-6508-4933-9fc4-94d732959919", "name": "Suno", "description": { "content": "Generate songs on Suno from lyrics + style, and poll their progress.", "type": "text/plain" }, "item": [ { "id": "54ae1fb1-fae0-457b-b581-66c036beb764", "name": "Get song", "request": { "name": "Get song", "description": { "content": "Poll a single generated clip by id. When `status` is `complete`, `audioUrl` (MP3) and `imageUrl` are populated. Requires `suno:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "suno", "songs", ":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": "daa1139a-3d34-4965-8200-95eb55df297c", "name": "song", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"status\": \"running\",\n \"audioUrl\": \"string\",\n \"imageUrl\": \"string\",\n \"title\": \"string\",\n \"durationSec\": 6657.678885618916,\n \"model\": \"string\",\n \"errorType\": \"string\",\n \"errorMessage\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d9568d9-b36a-463c-bc94-f66c71735f64", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2dd06a2-feba-411c-9397-f8d7f81177ca", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8afda83-d30c-445d-ab08-a44e3ff09ca5", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ee80561-3655-4682-a882-cd43442e7e93", "name": "Resource not found.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2774fde-669c-47ea-8347-2bf7163b86a8", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4bf61c33-a049-41ee-aae5-0a61e0b6a796", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56b62bf8-05cb-454d-86fa-8bc2df529dfd", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs", ":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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "8799c232-5a3b-416a-8e81-7cf19f7ce870", "name": "Generate song", "request": { "name": "Generate song", "description": { "content": "Submit a song generation to Suno from `lyrics` + `style`, optionally steering `vocalGender`, `weirdness`, `styleInfluence`, and a reference recording (`uploadId` from POST /v1/suno/uploads, with `audioInfluence` controlling how closely the cover follows it). Returns two clip variants — poll each with `GET /v1/suno/songs/{id}` until `status` is `complete`. Requires `suno:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"\",\n \"style\": \"\",\n \"negativeStyle\": \"\",\n \"vocalGender\": \"\",\n \"weirdness\": \"\",\n \"styleInfluence\": \"\",\n \"audioInfluence\": \"\",\n \"instrumental\": \"\",\n \"model\": \"\",\n \"title\": \"\",\n \"uploadId\": \"\",\n \"captchaToken\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cb7da724-363f-4319-adaf-d78afc64a274", "name": "generation submitted", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"jobId\": \"string\",\n \"clips\": [\n {\n \"id\": \"string\",\n \"status\": \"submitted\",\n \"audioUrl\": \"string\",\n \"imageUrl\": \"string\",\n \"title\": \"string\",\n \"durationSec\": 8982.756510309757,\n \"model\": \"string\",\n \"errorType\": \"string\",\n \"errorMessage\": \"string\"\n },\n {\n \"id\": \"string\",\n \"status\": \"queued\",\n \"audioUrl\": \"string\",\n \"imageUrl\": \"string\",\n \"title\": \"string\",\n \"durationSec\": 9628.240100019853,\n \"model\": \"string\",\n \"errorType\": \"string\",\n \"errorMessage\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8094ad6d-a75e-4778-9ad3-9aea8ef63a0d", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1092d26e-fc8b-48c1-818e-26097a755b18", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e526706f-3f16-4c9a-9bea-5f8cfeac8135", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea50247c-e635-4a09-a8a1-0137b5cddac6", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c764c2b-bd3c-491b-959c-85c50e213375", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b29bd40-00d2-46fe-8db7-0b3b4007a04f", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "suno", "songs" ], "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 \"lyrics\": \"[Verse]\\nSunlight on the open road\\n[Chorus]\\nWe are the morning\",\n \"style\": \"upbeat pop, acoustic guitar\",\n \"vocalGender\": \"f\",\n \"weirdness\": 0.4,\n \"styleInfluence\": 0.7\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "f750fabb-f63a-4dc3-9186-ed5a0487f73c", "name": "Upload reference audio", "request": { "name": "Upload reference audio", "description": { "content": "Upload an audio recording (via `audioUrl` or base64 `audioBase64`) to Suno. Returns an `uploadId` to pass to POST /v1/suno/songs as `uploadId` to cover/transform it. Max 500 MB. Requires `suno:write`.", "type": "text/plain" }, "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"\",\n \"audioBase64\": \"\",\n \"fileName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "fd39ef19-3090-4035-a627-1ee6c0c75b31", "name": "upload ready", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": true,\n \"data\": {\n \"uploadId\": \"string\",\n \"status\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d7365f7-90d0-49a6-8ee8-fb66c28dcf16", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd17d54c-ae1c-4da4-a918-a57c7b100db4", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ef2d273-d36d-4337-bce6-21a625ada2c2", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "054be480-b077-4cb5-bcdb-d71f63f24565", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eab73464-6ae1-42ea-9269-87bc810a8fa4", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61090bf5-7c43-48de-9088-ab54edfa5c8c", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "suno", "uploads" ], "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 \"audioUrl\": \"https://example.com/me-singing.mp3\",\n \"fileName\": \"me-singing.mp3\"\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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "7cf169b7-5238-4bb4-b26f-01015c4155c4", "name": "Get Suno account", "request": { "name": "Get Suno account", "description": { "content": "Remaining credits, monthly usage, and plan on the connected Suno account. Requires `suno:read`.", "type": "text/plain" }, "url": { "path": [ "v1", "suno", "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a423a79d-b28c-4b7a-b773-be0c7ad20096", "name": "suno account", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"creditsLeft\": 8600.508270711167,\n \"monthlyLimit\": 6876.214444744291,\n \"monthlyUsage\": 6509.606379929675,\n \"plan\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06b43e8c-23b2-4c94-86fa-eefccaa97844", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4be08a9f-7de5-4ba5-9036-73143477359a", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb01dba5-272a-47b3-8f12-8111822d751f", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f91f71c2-5acf-442d-8f1a-1ad02e994a96", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af01489a-5e20-4315-b237-e77efa60ae8e", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f41411a2-d69f-4701-948e-3bc9d10d14e8", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "suno", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "69062d81-a6a2-4746-aef0-28b6c5f851d2", "name": "Webhooks", "description": { "content": "Register URLs to receive HTTPS POSTs on Blueticks events.", "type": "text/plain" }, "item": [ { "id": "d1974e3c-e86f-4043-ab27-feb60d8af7dc", "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": "order", "value": "desc", "description": "Sort direction by timestamp: `asc` (oldest first) or `desc` (newest first, default)." }, { "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": "28df6771-3b41-4b96-8a88-7c1e050cbc09", "name": "list", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"status\": \"disabled\",\n \"createdAt\": \"1979-05-25T19:29:56.807Z\",\n \"description\": \"string\"\n },\n {\n \"id\": \"string\",\n \"url\": \"string\",\n \"events\": [\n \"string\",\n \"string\"\n ],\n \"status\": \"enabled\",\n \"createdAt\": \"1988-05-15T01:29:04.627Z\",\n \"description\": \"string\"\n }\n ],\n \"limit\": 6933,\n \"skip\": 2838,\n \"total\": 3054\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b4e8ca8-be63-4be7-93e6-6274efbb8494", "name": "Bad request — invalid params or body.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22519249-c3e7-431a-a526-8cfa079d5326", "name": "Missing or invalid API key.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "870f2179-00e5-4c6b-ad0d-a47f357b603d", "name": "API key lacks the required scope.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79436ff1-bb24-4f97-ba58-98b3ead90f2d", "name": "Validation failed — see `error.details` for per-field issues.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d2d6313-0ba9-4472-8d78-68874144e463", "name": "Rate limit exceeded — back off and retry.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78a827be-d152-4fdf-8a34-04a1ec9cb095", "name": "Internal server error.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "order", "value": "desc" }, { "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "434b97a3-1d37-4578-b652-62283ab16b59", "name": "Create webhook", "request": { "name": "Create webhook", "description": { "content": "Register a new webhook.", "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": "1cb7f8c3-7e9c-4627-9c19-63983980a938", "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 \"status\": \"disabled\",\n \"createdAt\": \"2013-07-15T10:24:02.564Z\",\n \"description\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b1c16ea-0410-494a-8422-085ffc549655", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bb83d0d-0a20-4319-87c0-36f30501d7f5", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e22ccc72-a226-4838-834c-726c1e535d1c", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "27cc01df-6b28-471c-b807-5e3093246ab0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c55085e-7cbe-40fa-896d-e27750a9aa16", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb5a02de-7975-4b64-93a8-f7115fde5bea", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "d4136456-a333-423f-8bf1-6c45fc070961", "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": "ee6a974d-3e3c-4949-adad-ca904b0dd1a3", "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 \"status\": \"disabled\",\n \"createdAt\": \"2013-07-15T10:24:02.564Z\",\n \"description\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a01e449a-9f41-413b-a088-7fdd63b8ffd0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74ecc4bd-a9ab-4a6d-88b5-4886864d6dc0", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5272060-5e72-43cb-9eb5-8d5a212d629f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f103212-c04b-4514-8a9a-091b1ac4ecc8", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f81832d7-e664-4b04-a51c-a6e4bbe251b8", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37ce1896-eb35-48ac-b90a-b2ce6c543551", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "051b47f3-86e5-439d-b211-6640bf3df070", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "0cdb7508-86c6-4971-8770-090c9c41d5f1", "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": "6650e08e-b837-44b0-93a7-c47fef4c18f1", "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 \"status\": \"disabled\",\n \"createdAt\": \"2013-07-15T10:24:02.564Z\",\n \"description\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "508d472e-0daf-4d2b-ab56-f385a6e4077e", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42567833-65a0-450e-99eb-20e7bc150dc9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cad3be8-2e94-4d80-9190-dfa92d34c821", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2ba6523-bb88-4826-a4b8-55aedfbf8657", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15f19018-6a5a-4f29-b7ba-8e714ab7b1c1", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3831944c-ad33-46a7-aaab-010d4092683f", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60dbd283-bf7d-411b-a2ce-916ff6da9722", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "1e4edae9-2494-4029-8b1c-f4f4bcf33733", "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": "dda9d2a8-6dc5-412e-aec4-9231fd3f7279", "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": "6f3c3950-83e0-4f0d-bddc-5f5b9f5384ce", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35c87252-e744-4f21-9084-601527ea1fce", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b62fe95-976a-407a-8953-1761ee2797a9", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "893d62b8-006c-465d-85f6-76e82a5dfdff", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2a00f15-b766-462b-bc6c-419d9ed64e3d", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e223d2e-5d54-473f-b558-1e372606ad35", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"path\": \"string\",\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b61b6a6a-088a-4d23-967a-634ce795090a", "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 \"requestId\": \"string\",\n \"details\": [\n {\n \"path\": \"string\",\n \"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": "8a686dda-3101-4055-89f5-e76448190ed6", "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." } }