{ "item": [ { "name": "routes", "description": "", "item": [ { "id": "6ca06d42-55f3-49be-8b8b-69deecc10e5a", "name": "Create Route", "request": { "name": "Create Route", "description": { "content": "Reserve quota, persist + enqueue, and return 202 + the poll seed (D-06/D-07/D-16).\n\n``Idempotency-Key`` is OPTIONAL and additive (D-08): a MISSING header keeps the 16-02 create\nbyte-identical (``_plain_create``, ``commit=True``, no claim). A PRESENT header routes through\nthe SHARED idempotency helper — ``ensure_key_length`` caps it (T-17-13), ``compute_fingerprint``\ncanonicalizes the body (D-07), and ``begin`` decides: a REPLAY loads the ORIGINAL route by its\nclaim's ``resource_id`` and echoes it (202 + ``Idempotent-Replay: true``) reserving ZERO new\nquota (D-16a), a swapped body raises 409 ``idempotency_key_conflict`` (D-07), and a CLAIM\nproceeds to ``_claim_create`` (reserve → create → single atomic commit → enqueue). Routes remain\nNON paid-gated (D-08/D-12) — the header adds durability, not a plan gate.", "type": "text/plain" }, "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "937dcf23-2f1b-438c-b42d-e5d04d03d0f7", "name": "Successful Response", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"optimized\",\n \"stops\": [\n {\n \"seq_input\": \"\",\n \"label\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"seq_optimized\": \"\",\n \"eta\": \"\"\n },\n {\n \"seq_input\": \"\",\n \"label\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"seq_optimized\": \"\",\n \"eta\": \"\"\n }\n ],\n \"total_distance_m\": \"\",\n \"total_duration_s\": \"\",\n \"polyline\": \"\",\n \"handoff_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67ac8010-8b18-403a-9d18-0bafefc5d70f", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2274aa2f-0975-4b79-a821-ce30c53694c2", "name": "Subscription, quota or credit refusal (`quota_exceeded` / `credits_exhausted` / `overage_cap_reached` / `subscription_canceled` / `subscription_locked`).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343cd447-a688-4b22-b9d5-b782598d6587", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f71bb3fc-ab96-476c-844b-71c968ed417b", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "698165ef-4fe9-42eb-99d5-0ce1f5277bf2", "name": "Conflict (`idempotency_key_conflict` — a reused Idempotency-Key with a different body; `webhook_limit_reached` — the per-tenant webhook subscription cap).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b45b33d0-e444-4e2e-ad84-d8b2fbd8fb09", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb575d8b-901e-4055-bd03-f4dc049b9e19", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0879d190-0585-42af-8be3-3adc4cfed6f8", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "199708b5-18c1-4ef0-92bd-380a03315033", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "routes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"stops\": [\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n }\n ],\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "50496644-7097-476a-b20a-69ad6e9951c6", "name": "Get Route", "request": { "name": "Get Route", "description": { "content": "Poll a tenant-owned route; embed the lazy driver hand-off once optimized (D-06/D-08).\n\nLoads the route scoped to ``principal.tenant_id`` AND mode-filtered to the key's mode\n(``is_test=(principal.mode == KeyMode.test)``, D-14) — an unknown, foreign, OR cross-mode id\nrenders the uniform ``not_found`` 404 (no 403-vs-404 oracle, T-16-06). Once the route is done it\nget-or-creates the driver hand-off token via ``ensure_share_token`` (idempotent — two polls\nyield the SAME ``/d/{token}`` link, D-08) and embeds the absolute URL from the configured SPA.", "type": "text/plain" }, "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "route_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a8351da3-1ff9-44a7-8653-469ae80c3f82", "name": "Successful Response", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"optimized\",\n \"stops\": [\n {\n \"seq_input\": \"\",\n \"label\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"seq_optimized\": \"\",\n \"eta\": \"\"\n },\n {\n \"seq_input\": \"\",\n \"label\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"seq_optimized\": \"\",\n \"eta\": \"\"\n }\n ],\n \"total_distance_m\": \"\",\n \"total_duration_s\": \"\",\n \"polyline\": \"\",\n \"handoff_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3953f2a2-ea07-4d0b-a117-d4849560aa26", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0118cbe1-0bf9-41d3-b6fa-52f12110c447", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea5b812a-1d31-41eb-8f5a-f4fdb26b68a8", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0703ebb3-a052-4d7f-9197-eddc2d452fae", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07f88726-3b1b-4c3c-a47e-f940cb468e95", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf9f473a-6439-4a51-9fb2-35842b58a05e", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53d8c1a6-03dd-4496-83d5-2e7f0e19e73d", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "routes", ":route_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "route_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "usage", "description": "", "item": [ { "id": "364b6fbc-5a69-4d1d-b1ba-0cbe250af4b4", "name": "Read Usage", "request": { "name": "Read Usage", "description": { "content": "Return the caller tenant's current-period usage + limits + subscription state (D-18/D-05).\n\nFunnels the SAME two dashboard reads: ``get_usage`` yields ``(period_label, [(metric, used,\nlimit), ...])`` for routes/whatsapp/sms, and ``get_subscription`` yields the tenant's\nsubscription + plan key (its ``status`` / ``current_period_end`` / ``cancel_at_period_end`` are\nthe D-18 subscription state). Both scope strictly to ``principal.tenant_id`` (T-16-11) and each\nreturns ``None`` for a no-subscription tenant — handled as the null/zeroed shape below. The read\nis serialized through the public ``UsageResource`` (D-04); no internal cost fields cross over.\n\nUnder a ``dk_test_`` key (``principal.mode == KeyMode.test``, 19-07 / D-05) the metric usage +\nthe ``period`` label instead come from the TEST namespace via ``get_test_usage`` (the\n``test:{period}`` counters against the named test caps) and ``livemode`` is ``False`` — the live\ncounter rows are byte-untouched. The subscription-state fields are unchanged (account state is\northogonal to test mode). A live key keeps the byte-stable D-18 shape with ``livemode`` true.", "type": "text/plain" }, "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3c9b33c8-0b54-4998-8421-bbb3e82d12a3", "name": "Successful Response", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"routes\": {\n \"used\": \"\",\n \"limit\": \"\"\n },\n \"whatsapp\": {\n \"used\": \"\",\n \"limit\": \"\"\n },\n \"sms\": {\n \"used\": \"\",\n \"limit\": \"\"\n },\n \"plan\": \"\",\n \"subscription_status\": \"\",\n \"current_period_end\": \"\",\n \"cancel_at_period_end\": false,\n \"period\": \"\",\n \"livemode\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "429b2da3-2f8f-4b7f-bb02-6fe352625406", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3cc4c62-b03d-4c56-87db-cde13a22acbf", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "108d19dc-d15b-4b57-a1fb-a9bb7010aa24", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbeb911a-c651-4877-bcbc-c44bc5c03b93", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89af5b16-f766-478f-a30d-49414e4aeec6", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "usage" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "campaigns", "description": "", "item": [ { "id": "06d24aeb-ecfb-4efb-a0c8-9a2ea6b57cce", "name": "Create Campaign", "request": { "name": "Create Campaign", "description": { "content": "Paid-gate, reserve, persist + enqueue, and return 202 + the poll seed (API-03/API-08/API-09).\n\nThe ORDER is load-bearing: (1) the PAID GATE FIRST, but ONLY for a LIVE key (D-18) — a LIVE\n``trialing`` / no-sub tenant is refused 403 ``paid_plan_required`` before any reserve/claim/send\n(D-10); a ``dk_test_`` key SKIPS the gate so test-mode creation is open to trialing tenants.\n(2) ``Idempotency-Key`` is OPTIONAL and additive (D-08): a MISSING header runs ``_plain_create``\n(``commit=True``, no claim); a PRESENT header routes through the SHARED idempotency helper —\n``ensure_key_length`` caps it (T-17-13), ``compute_fingerprint`` canonicalizes the body (D-07),\nand ``begin`` decides: a REPLAY loads the ORIGINAL campaign by its claim's ``resource_id`` and\nechoes it (202 + ``Idempotent-Replay: true``) reserving ZERO new quota and enqueuing NO send\n(D-16a), a swapped body raises 409 ``idempotency_key_conflict`` (D-07), and a CLAIM proceeds to\n``_claim_create`` (READ pre-gate → create → single atomic commit → enqueue). ``canceled`` /\n``locked`` surface their existing 402 via ``check_quota``; an invalid phone → 422 (D-14).", "type": "text/plain" }, "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6d310a67-d228-4af0-803f-f69bafd6e766", "name": "Successful Response", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"expired\",\n \"contacts\": [\n {\n \"state\": \"delivered\",\n \"phone\": \"\",\n \"name\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"failure_reason\": \"provider_error\"\n },\n {\n \"state\": \"excluded\",\n \"phone\": \"\",\n \"name\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"failure_reason\": \"credits_exhausted\"\n }\n ],\n \"route_id\": \"\",\n \"purged_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f24d6a0-1e7f-4ecf-aedb-ea7bf9a7d1a3", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "79985c52-79e7-457c-8250-d4a1bcddbf13", "name": "Subscription, quota or credit refusal (`quota_exceeded` / `credits_exhausted` / `overage_cap_reached` / `subscription_canceled` / `subscription_locked`).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31239a97-ccf4-4d08-b8e5-1a17d399e651", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84be3c47-fbe1-45b6-b18a-10d5472fb09c", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcea86d6-075d-475f-85fe-fc359d3a57fc", "name": "Conflict (`idempotency_key_conflict` — a reused Idempotency-Key with a different body; `webhook_limit_reached` — the per-tenant webhook subscription cap).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5edf05d8-8cb3-4252-a32e-4f782d6f27ad", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6d714ba-c88b-4444-9199-62da4cefb159", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e3f7981-2193-48cc-8d1c-4382e1154b57", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "044162c8-0c16-41d8-8043-5fda0c912955", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"phone\": \"\",\n \"name\": \"\",\n \"language\": \"ar\",\n \"channel\": \"whatsapp\",\n \"reference\": \"\"\n }\n ],\n \"start\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"deadline_at\": \"\",\n \"end\": {\n \"lat\": \"\",\n \"lng\": \"\",\n \"label\": \"\"\n },\n \"traffic\": false,\n \"round_trip\": true,\n \"language\": \"ar\",\n \"reminder_hours\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60c73a60-de35-43b4-95b3-6ad688de4ba7", "name": "Get Campaign", "request": { "name": "Get Campaign", "description": { "content": "Poll a tenant-owned campaign — contact states + coords as they arrive + honest purged state.\n\nLoads the campaign scoped to ``principal.tenant_id`` AND mode-filtered to the key's mode\n(``is_test=(principal.mode == KeyMode.test)``, D-14; ``selectinload`` contacts) — an unknown,\nforeign, OR cross-mode id renders the uniform ``not_found`` 404 (no 403-vs-404 oracle, T-17-20).\nOtherwise it serializes through ``to_campaign_resource``: contact ``state`` + lat/lng where a\nlocation has arrived, ``route_id`` once auto-optimize links the route, and — once ``purged_at``\nis set — an HONEST scrubbed resource (lat/lng/phone forced null) that is NEVER a 404 and never\nresurrects PII through the API (D-13/D-16e).", "type": "text/plain" }, "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "campaign_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c4fe13ca-68b2-4dc3-85be-9c37f2004694", "name": "Successful Response", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"expired\",\n \"contacts\": [\n {\n \"state\": \"delivered\",\n \"phone\": \"\",\n \"name\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"failure_reason\": \"provider_error\"\n },\n {\n \"state\": \"excluded\",\n \"phone\": \"\",\n \"name\": \"\",\n \"lat\": \"\",\n \"lng\": \"\",\n \"failure_reason\": \"credits_exhausted\"\n }\n ],\n \"route_id\": \"\",\n \"purged_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9b93ec97-b7f0-402e-872a-f5d1658e7624", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cce7abe-de78-4ac1-a5da-3f7acf021199", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8dfd1a7f-99ca-4cc3-a800-763104997f8a", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "168d9dcf-072d-4360-8e59-e4e0dc13d053", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f944a77-2aa6-4bf5-8100-a874bc86c123", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57a253cb-024b-4f94-8dd1-681e5d3b6fb5", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee93b04-ae70-4338-96cc-c00ec12e15c7", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "campaigns", ":campaign_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "campaign_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "fffcb6c9-b8ea-4fde-8363-c59600ba3e0c", "name": "List Webhooks", "request": { "name": "List Webhooks", "description": { "content": "List the caller's subscriptions, newest-first — tenant-scoped; NO secret crosses (D-13).", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "47e20197-df35-4e1a-ade0-2919b26e3ce9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"location.collected\",\n \"route.optimized\"\n ],\n \"mode\": \"live\",\n \"status\": \"active\",\n \"created_at\": \"\",\n \"disabled_at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\",\n \"route.optimized\"\n ],\n \"mode\": \"live\",\n \"status\": \"disabled\",\n \"created_at\": \"\",\n \"disabled_at\": \"\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0b00953-59df-4028-8d73-17901c24a1bc", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73923b18-2245-4835-aec1-7d487d98c2e2", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff4fdda2-92a7-4f37-8741-3a943ee8ce13", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08a3f7ab-bf94-4b0b-aeff-cf74de63f671", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc9c887b-1039-429f-824a-5f69cd3b5b36", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b776cdd-6ac3-4f37-a15a-768cd330b71e", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "43bb8288-303b-40f1-a5dc-41d881bcc1f4", "name": "Create Webhook", "request": { "name": "Create Webhook", "description": { "content": "Register a subscription and return the resource + the signing secret exactly once (WHK-01).\n\nDelegates to ``create_subscription`` (registration-time https-only + SSRF validation, the D-19\ncap over active rows, a fresh ``whsec_`` secret Fernet-encrypted at rest). A refused URL →\n422 ``validation_error``; the cap → 409 ``webhook_limit_reached``. No paid gate / Idempotency\n-Key / quota draw (D-18 — CONFIG not spend). The raw secret rides the response ONCE (D-13).\n\nThe subscription mode is DERIVED FROM THE KEY (D-15): ``key_mode = WebhookMode(principal.mode\n.value)`` — a ``dk_test_`` key registers a ``mode=test`` subscription, a live key a live one, so\na test key can never register a live subscription. ``body.mode`` is OPTIONAL: omitted → the key\nmode; present-and-contradictory → the ``validation_error`` envelope (the key always wins).", "type": "text/plain" }, "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "567ca9d2-a41e-44dd-8758-62de5be9a150", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\",\n \"location.collected\"\n ],\n \"mode\": \"live\",\n \"status\": \"active\",\n \"created_at\": \"\",\n \"secret\": \"\",\n \"disabled_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "639036ab-27d4-4b79-9bba-1d029e40bcb7", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1e3779f9-bd20-4292-8f18-db7adad55a9d", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0e6c7a5-50da-4493-995a-d20e1882ded6", "name": "Conflict (`idempotency_key_conflict` — a reused Idempotency-Key with a different body; `webhook_limit_reached` — the per-tenant webhook subscription cap).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14ba5cab-b98d-4d7d-a5a3-d186ef5b60e8", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87ed5535-dfe1-45de-ba41-2c8c85289564", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "423fe8e8-7301-40e7-a933-1b2990a5841d", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5bbd5d30-2e77-4375-8f5a-1904a20608e0", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\"\n ],\n \"mode\": \"test\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "740e5eb3-d9ab-4341-984b-6939f7ec4c51", "name": "Get Webhook", "request": { "name": "Get Webhook", "description": { "content": "Read one tenant-owned subscription; an unknown/foreign id is the uniform not_found.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "subscription_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3ccaf701-6798-4500-8b5b-96826385d27e", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"location.collected\",\n \"route.optimized\"\n ],\n \"mode\": \"live\",\n \"status\": \"disabled\",\n \"created_at\": \"\",\n \"disabled_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14ac3d70-6cc1-4373-ba52-be65acfe3fba", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b923e6c0-4945-48e0-b139-9a98929e457d", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c94cab1-9d01-49ba-821c-d483121c15d4", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e49111de-b7ca-4ac0-a857-88f5ea4bfd5b", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4c94ef8-b9bf-4f94-a2d0-99a69b08f00d", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59477d67-67fa-42dc-9fed-f25ad7a81682", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff48163f-32b7-44b1-9c96-37188b4916f3", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4bdfe91e-1896-4781-b39e-7193922ae467", "name": "Update Webhook", "request": { "name": "Update Webhook", "description": { "content": "Update a subscription's URL and/or events; the URL is re-validated (registration SSRF, D-11).\n\nA present ``url`` re-runs the https-only + SSRF guard (a rebind to an internal target is refused\non update too) → 422 ``validation_error`` on refusal. A foreign/unknown id is the uniform 404.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "subscription_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ec4262c0-67f4-4b19-81df-d6636b60d777", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"location.collected\",\n \"route.optimized\"\n ],\n \"mode\": \"live\",\n \"status\": \"disabled\",\n \"created_at\": \"\",\n \"disabled_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1416ef26-8cbe-43b0-99e7-878050dd0113", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf43176d-d7ad-4a42-8643-23095757cdc9", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6387fa4b-6d77-4f8f-bc0b-0a83c4ac6570", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d7c98ec-c91e-4921-8d33-b25ce93c795d", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b50f2b35-ef8b-4660-a40c-d2786dca43c9", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96dbe6cd-0a98-4b57-bc1f-8677fd8cff7b", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b74718d5-9d04-4535-b680-e6c1866fd0e2", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"location.collected\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "454c1cb3-36e8-4353-a43b-a4c97167467d", "name": "Delete Webhook", "request": { "name": "Delete Webhook", "description": { "content": "Delete a tenant-owned subscription (204); a foreign/unknown id is the uniform not_found.", "type": "text/plain" }, "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "subscription_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "24caf727-0b0b-4158-a31a-b4bce6f1b204", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6bc43b9b-891d-413c-81d9-a78d1d001962", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a1e9e4b7-d355-4959-99b7-43668f07f595", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d7f31a4a-9c97-4a2a-b62f-0400dbad0450", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "728a7df2-3850-4356-9ccf-09600091fc88", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd0ebf92-5695-44b1-a6aa-79776fcc3519", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12501658-4b4c-437d-8690-8cc2e0a7b22a", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4174ec73-6a0a-4b7b-9b66-2cfb8e5420e2", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82134a5e-1b2d-48d9-937a-e3a66d402f87", "name": "Regenerate Webhook Secret", "request": { "name": "Regenerate Webhook Secret", "description": { "content": "Rotate the signing secret and return the fresh value ONCE; the old secret stops verifying.\n\nTenant-scoped: a foreign/unknown id is the uniform not_found 404. The new Fernet token replaces\nthe old immediately (no grace window — a rotating tenant registers a second subscription for\noverlap). The raw secret is returned exactly once (D-13).", "type": "text/plain" }, "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "subscription_id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2635a23b-2fd0-410b-a736-320c090c9cc9", "name": "Successful Response", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"events\": [\n \"campaign.completed\",\n \"location.collected\"\n ],\n \"mode\": \"live\",\n \"status\": \"active\",\n \"created_at\": \"\",\n \"secret\": \"\",\n \"disabled_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53ec193c-7269-42c6-93f5-7d081ed324a6", "name": "Missing or invalid API key (`unauthorized`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a0203ae-e3f6-4f7c-9c39-bf9fcfd902af", "name": "Refused (`test_mode_unavailable` / `email_unverified` / `paid_plan_required` / `live_key_browser_forbidden`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b06cd2d-1bd7-4f3f-8d54-b9e8d3f8fc4f", "name": "Unknown or foreign resource id (`not_found`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6a477ad-2834-4941-b29c-4cdc9a7bb745", "name": "Request failed validation (`validation_error`; field errors under `details.errors`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "526c4265-243e-4b07-a207-dc8d7c268b33", "name": "Rate limit exceeded (`rate_limited`; honest `Retry-After` + `X-RateLimit-*` headers).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3057fde-0396-4bb5-abf8-0743a1ead135", "name": "Unexpected server error (`internal_error`; no internals leak).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ffdb7009-9bb9-4c90-921f-bf3fbd085fdd", "name": "Rate-limit backend unavailable (`service_unavailable`; retry after `Retry-After`).", "originalRequest": { "url": { "path": [ "webhooks", ":subscription_id", "regenerate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "subscription_id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\",\n \"details\": {\n \"key_0\": false,\n \"key_1\": false,\n \"key_2\": 7729.857186131193,\n \"key_3\": 7771\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "/" } ], "info": { "_postman_id": "c0f3ab0e-80ca-4fed-bdd5-a6b3192b4957", "name": "Darb Public API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "", "type": "text/plain" } } }