{ "info": { "_postman_id": "e34a8fda-ecfc-4061-a1a4-721e515524d6", "name": "Amigo Account Surfaces API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:02:51.000Z", "updatedAt": "2026-07-28T01:02:51.000Z", "lastUpdatedBy": "35240", "uid": "35240-e34a8fda-ecfc-4061-a1a4-721e515524d6" }, "item": [ { "name": "v1", "item": [ { "name": "{workspace_id}", "item": [ { "name": "surfaces", "item": [ { "name": "review", "item": [ { "name": "List surfaces pending review", "id": "f83a2c2d-a314-4eaa-bcbf-9e11658a2099", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/review?limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", "review" ], "query": [ { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "f2a8cded-75d9-47e0-86a9-f3f8764154c4", "key": "workspace_id", "value": "", "description": "(Required) " } ] }, "description": "List surfaces pending review.\n\nField engineers use this to approve or reject surfaces before delivery.\n\nPermissions: operator, member, admin, owner (ReviewQueue:View)" }, "response": [ { "id": "48cdc2bb-97d8-41c1-aa0e-278c2d27c181", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/review?limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", "review" ], "query": [ { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"status\": \"opened\",\n \"fields_count\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"resource_type\": \"\",\n \"context\": {},\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"opened_at\": \"\",\n \"submitted_at\": \"\",\n \"submitted_data\": {\n \"Lorem_b_f\": \"dolore enim\",\n \"quis8_\": false\n },\n \"delivery_metadata\": {\n \"irure_928\": true,\n \"magna_2\": 23114794.6979903\n },\n \"review_notes\": \"\",\n \"reviewed_by\": \"\",\n \"reviewed_at\": \"\",\n \"archived_at\": \"\",\n \"archive_reason\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"status\": \"partial\",\n \"fields_count\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"resource_type\": \"\",\n \"context\": {},\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"opened_at\": \"\",\n \"submitted_at\": \"\",\n \"submitted_data\": {\n \"amet3\": true,\n \"sed_2\": -83162128.46480569,\n \"occaecat4\": true,\n \"culpade6\": 54217128\n },\n \"delivery_metadata\": {\n \"irure_b\": true\n },\n \"review_notes\": \"\",\n \"reviewed_by\": \"\",\n \"reviewed_at\": \"\",\n \"archived_at\": \"\",\n \"archive_reason\": \"\",\n \"url\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-48cdc2bb-97d8-41c1-aa0e-278c2d27c181" }, { "id": "e9e8c336-785a-4ee3-8b7d-ba868366bdf4", "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/review?limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", "review" ], "query": [ { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-e9e8c336-785a-4ee3-8b7d-ba868366bdf4" }, { "id": "4df65f42-b429-475a-886e-ab98c5a58f88", "name": "Rate limited", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/review?limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", "review" ], "query": [ { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-4df65f42-b429-475a-886e-ab98c5a58f88" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-f83a2c2d-a314-4eaa-bcbf-9e11658a2099" } ], "id": "961947a0-612f-4b91-b7e2-0727b78119f9", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-961947a0-612f-4b91-b7e2-0727b78119f9" }, { "name": "{surface_id}", "item": [ { "name": "approve", "item": [ { "name": "Approve a surface pending review", "id": "bf48e033-7cba-4815-b7eb-95ae0e72bc23", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "approve" ], "variable": [ { "id": "8b0911ec-9734-4d12-b273-d213d2fcafa0", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "41371683-6871-46dc-b3f3-68b8224f41a4", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Approve a surface pending review.\n\nThe surface returns to CREATED status and can then be delivered.\n\nPermissions: operator, member, admin, owner (ReviewQueue:Review)" }, "response": [ { "id": "b34bebdf-b32e-413c-bdf9-afc5f8d405bb", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "approve" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"surface_id\": \"\",\n \"status\": \"partial\",\n \"action\": \"approved\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-b34bebdf-b32e-413c-bdf9-afc5f8d405bb" }, { "id": "f68155b9-1372-4eb9-9998-1fa8174a926a", "name": "Surface not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "approve" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-f68155b9-1372-4eb9-9998-1fa8174a926a" }, { "id": "02692a89-3d25-4368-b665-c0e2e3893b1a", "name": "Surface is not pending review", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "approve" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-02692a89-3d25-4368-b665-c0e2e3893b1a" }, { "id": "fd5497d9-2750-45fe-a572-d9021f5e615f", "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "approve" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-fd5497d9-2750-45fe-a572-d9021f5e615f" }, { "id": "fbe581f5-38aa-4e8a-9620-90f79ff43b2a", "name": "Rate limited", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/approve", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "approve" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-fbe581f5-38aa-4e8a-9620-90f79ff43b2a" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-bf48e033-7cba-4815-b7eb-95ae0e72bc23" } ], "id": "2dc2d26d-a9ec-46db-abac-ad433e55d3ed", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-2dc2d26d-a9ec-46db-abac-ad433e55d3ed" }, { "name": "reject", "item": [ { "name": "Reject a surface pending review", "id": "8740e4d8-bc97-4b30-86ef-617e66aab4cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reject" ], "variable": [ { "id": "64fb91f7-5955-4b22-8c62-e354e98ba9c8", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "4891ed73-5ba8-4254-b997-9f5fa0f63b1b", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Reject a surface pending review.\n\nThe surface is marked as expired and will not be delivered.\n\nPermissions: operator, member, admin, owner (ReviewQueue:Review)" }, "response": [ { "id": "777645cb-7c4a-4538-b054-777b1092a34f", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reject" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"surface_id\": \"\",\n \"status\": \"partial\",\n \"action\": \"approved\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-777645cb-7c4a-4538-b054-777b1092a34f" }, { "id": "3a9073a7-498d-4804-85f1-4be9e18dbb95", "name": "Surface not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reject" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-3a9073a7-498d-4804-85f1-4be9e18dbb95" }, { "id": "dc561178-0f25-4101-8209-7b82df45a6ff", "name": "Surface is not pending review", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reject" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-dc561178-0f25-4101-8209-7b82df45a6ff" }, { "id": "50e2e8d2-5104-4604-809c-17ab7ddc39f6", "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reject" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-50e2e8d2-5104-4604-809c-17ab7ddc39f6" }, { "id": "b547dc10-cc81-44d6-9082-c47722c90a01", "name": "Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reject", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reject" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-b547dc10-cc81-44d6-9082-c47722c90a01" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-8740e4d8-bc97-4b30-86ef-617e66aab4cf" } ], "id": "b00376eb-5d3d-45b8-9b0a-c59a1b65c9f4", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-b00376eb-5d3d-45b8-9b0a-c59a1b65c9f4" }, { "name": "progress", "item": [ { "name": "Get field-level completion status", "id": "e8b9e9cb-8463-4cf6-bdd6-07a160a83970", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "progress" ], "variable": [ { "id": "a6745a56-43da-41ee-890b-1d256bf1d9d3", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "2455d110-d4c2-4454-b9d8-0c9ae0fd0482", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Get field-level completion status for a surface.\n\nReturns which fields are filled vs empty, useful for abandonment\nintelligence and targeted re-engagement.\n\nPermissions: viewer, member, admin, owner (surfaces:read)" }, "response": [ { "id": "0e4f2978-f77d-488c-be22-3f072f898f76", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "progress" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"surface_id\": \"\",\n \"total_fields\": \"\",\n \"filled_count\": \"\",\n \"empty_count\": \"\",\n \"filled_keys\": [\n \"\",\n \"\"\n ],\n \"empty_keys\": [\n \"\",\n \"\"\n ],\n \"required_empty_keys\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-0e4f2978-f77d-488c-be22-3f072f898f76" }, { "id": "b04dc8ba-270d-4066-bd83-0c1dd05a4301", "name": "Surface not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "progress" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-b04dc8ba-270d-4066-bd83-0c1dd05a4301" }, { "id": "68fa4b3d-fa2e-4c17-a4d6-65a2de2a3aec", "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "progress" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-68fa4b3d-fa2e-4c17-a4d6-65a2de2a3aec" }, { "id": "47824779-23a9-47d6-83eb-c89c02e4622c", "name": "Rate limited", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/progress", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "progress" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-47824779-23a9-47d6-83eb-c89c02e4622c" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-e8b9e9cb-8463-4cf6-bdd6-07a160a83970" } ], "id": "decd7cc1-f09e-4eba-8cde-bf4eb7fb6397", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-decd7cc1-f09e-4eba-8cde-bf4eb7fb6397" }, { "name": "reshape", "item": [ { "name": "Create new surface with only unfilled fields", "id": "2bc69402-5a6e-4cce-af74-d169f64674bd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reshape", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reshape" ], "variable": [ { "id": "df38945f-b61d-4e51-8c8c-361d4d2e251b", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "f1a83353-049e-4b79-b4e1-c57aab27dacf", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Create a new surface with only the unfilled fields from the original.\n\nUsed for re-engaging patients who abandoned a form. The new surface\ncontains only the fields they haven't completed yet, reducing friction.\n\nPermissions: member, admin, owner (surfaces:write)" }, "response": [ { "id": "3881014d-973a-4bb1-a77a-bb8d5d62b9f9", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reshape", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reshape" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"status\": \"opened\",\n \"channel\": \"sms\",\n \"fields_count\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"use_case_id\": \"\",\n \"token\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-3881014d-973a-4bb1-a77a-bb8d5d62b9f9" }, { "id": "906ca00f-a23f-4e3b-b391-110ed509af5c", "name": "Surface not found", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reshape", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reshape" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-906ca00f-a23f-4e3b-b391-110ed509af5c" }, { "id": "966c785d-7f2b-4ae5-b20b-05d6050011b9", "name": "All fields already filled", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reshape", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reshape" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-966c785d-7f2b-4ae5-b20b-05d6050011b9" }, { "id": "df078ea7-51f1-474c-899f-b5ee9350e7f1", "name": "Validation Error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reshape", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reshape" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-df078ea7-51f1-474c-899f-b5ee9350e7f1" }, { "id": "4f81d153-49f8-4554-a6e3-3ea448750942", "name": "Rate limited", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/reshape", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "reshape" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-4f81d153-49f8-4554-a6e3-3ea448750942" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-2bc69402-5a6e-4cce-af74-d169f64674bd" } ], "id": "8c24691e-7ded-4e13-8048-1d64033116ce", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-8c24691e-7ded-4e13-8048-1d64033116ce" }, { "name": "deliver", "item": [ { "name": "Deliver Surface", "id": "73b25758-b0ea-4e85-987d-ad6553a28294", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "deliver" ], "variable": [ { "id": "85b0ee4c-8277-4e16-91d5-a165e7caee1e", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "3f329dbf-4bc1-462a-95d8-4467004f21e6", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Record a real delivery handoff for a surface.\n\nEmail targets are delivered through channel-manager's\n``POST /v1/email/`` (CM owns SES sender identity, IP pool, DKIM,\nsuppression \u2014 keyed on the surface row's ``use_case_id``). Phone-shaped\naddresses return 422 \u2014 SMS surface delivery was removed in PR #2783.\nOther targets record an external handoff that was completed outside\nplatform-api.\n\nPermissions: member, admin, owner (surfaces:write)" }, "response": [ { "id": "46644a34-91d6-4964-8da0-72a15045034c", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "deliver" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"surface_id\": \"\",\n \"status\": \"delivered\",\n \"channel_address\": \"\",\n \"channel\": \"sms\",\n \"url\": \"\",\n \"message_id\": \"\",\n \"from_number\": \"\",\n \"from_address\": \"\",\n \"delivery_provider\": \"\",\n \"delivered_at\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-46644a34-91d6-4964-8da0-72a15045034c" }, { "id": "6a2bb094-0561-4610-a278-db58998d0c88", "name": "Surface not found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "deliver" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-6a2bb094-0561-4610-a278-db58998d0c88" }, { "id": "665405c4-3f94-4821-8a47-d5c8cc3534e1", "name": "Surface already delivered/completed/expired", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "deliver" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-665405c4-3f94-4821-8a47-d5c8cc3534e1" }, { "id": "a0f007c2-3358-403d-b520-50033656fad3", "name": "Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "deliver" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-a0f007c2-3358-403d-b520-50033656fad3" }, { "id": "5fcc789d-8c0c-4bea-afa7-0e6439df08d4", "name": "Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_address\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id/deliver", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id", "deliver" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-5fcc789d-8c0c-4bea-afa7-0e6439df08d4" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-73b25758-b0ea-4e85-987d-ad6553a28294" } ], "id": "e32c63de-8114-4e3c-856e-cbdc5862afad", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-e32c63de-8114-4e3c-856e-cbdc5862afad" }, { "name": "Get Surface", "id": "02e3ddff-81ab-4016-a193-7b2c57b6d555", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "id": "0cbaf0ba-0e5f-4201-bd15-992d2d6fdff2", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "cc404ea7-c809-4102-9504-8c155368036d", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Get a surface by ID.\n\nReturns the surface spec and current lifecycle status. Also mints the\npatient-facing ``url`` so operators can copy/share the link from the read\nview (the token isn't stored, so it's re-minted on each read).\n\nPermissions: viewer, member, admin, owner (surfaces:read)" }, "response": [ { "id": "e47b69ca-66a6-4e32-b801-0f87b406c290", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"status\": \"completed\",\n \"fields_count\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"resource_type\": \"\",\n \"context\": {},\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"opened_at\": \"\",\n \"submitted_at\": \"\",\n \"submitted_data\": {\n \"nullac\": -81093042,\n \"ullamcob6\": -69956379.27159604,\n \"dolore835\": \"ea nostrud\"\n },\n \"delivery_metadata\": {\n \"commodo7\": -99036438.55147734\n },\n \"review_notes\": \"\",\n \"reviewed_by\": \"\",\n \"reviewed_at\": \"\",\n \"archived_at\": \"\",\n \"archive_reason\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-e47b69ca-66a6-4e32-b801-0f87b406c290" }, { "id": "33752c04-7ae6-4c8e-b2b0-864b0892bddc", "name": "Surface not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-33752c04-7ae6-4c8e-b2b0-864b0892bddc" }, { "id": "6e5626a4-35f8-4b3c-8db8-57dc9e873cb0", "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-6e5626a4-35f8-4b3c-8db8-57dc9e873cb0" }, { "id": "0a2922cc-4179-4d7a-b793-e4f2798727d9", "name": "Rate limited", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-0a2922cc-4179-4d7a-b793-e4f2798727d9" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-02e3ddff-81ab-4016-a193-7b2c57b6d555" }, { "name": "Update a surface spec", "id": "25826fe7-4705-4ddf-8ee5-cf9633bcca9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"email\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"nisi33b\": \"ut non eu\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"nulla7\": \"do Lorem\"\n },\n \"consent_text\": \"\"\n }\n ],\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"elit__62\": 50989265.128887475,\n \"eu2f\": -63495711,\n \"Lorem55d\": -15674876,\n \"dolor77f\": false\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"nisi_4\": 91791283,\n \"Duis5\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\",\n \"channel\": \"sms\",\n \"resource_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "id": "8309b2ec-e15d-4b26-8616-3173d9a75779", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "ce5c3521-84f4-4d39-8127-510165f4c904", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Update an existing surface spec.\n\nOnly allowed while status is CREATED or DELIVERED. Writes a\nsurface.updated event preserving the full audit trail.\n\nPermissions: member, admin, owner (Surface:Create)" }, "response": [ { "id": "d0d28991-4f3c-4cfc-a875-404b6cf79bac", "name": "Successful Response", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"email\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"nisi33b\": \"ut non eu\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"nulla7\": \"do Lorem\"\n },\n \"consent_text\": \"\"\n }\n ],\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"elit__62\": 50989265.128887475,\n \"eu2f\": -63495711,\n \"Lorem55d\": -15674876,\n \"dolor77f\": false\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"nisi_4\": 91791283,\n \"Duis5\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\",\n \"channel\": \"sms\",\n \"resource_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"status\": \"completed\",\n \"fields_count\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"resource_type\": \"\",\n \"context\": {},\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"opened_at\": \"\",\n \"submitted_at\": \"\",\n \"submitted_data\": {\n \"nullac\": -81093042,\n \"ullamcob6\": -69956379.27159604,\n \"dolore835\": \"ea nostrud\"\n },\n \"delivery_metadata\": {\n \"commodo7\": -99036438.55147734\n },\n \"review_notes\": \"\",\n \"reviewed_by\": \"\",\n \"reviewed_at\": \"\",\n \"archived_at\": \"\",\n \"archive_reason\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-d0d28991-4f3c-4cfc-a875-404b6cf79bac" }, { "id": "f2b34414-4e76-42d2-be7c-90286397c687", "name": "Surface not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"email\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"nisi33b\": \"ut non eu\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"nulla7\": \"do Lorem\"\n },\n \"consent_text\": \"\"\n }\n ],\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"elit__62\": 50989265.128887475,\n \"eu2f\": -63495711,\n \"Lorem55d\": -15674876,\n \"dolor77f\": false\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"nisi_4\": 91791283,\n \"Duis5\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\",\n \"channel\": \"sms\",\n \"resource_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-f2b34414-4e76-42d2-be7c-90286397c687" }, { "id": "f147a149-3620-4cdc-95b9-c910c87e4830", "name": "Cannot update in current status", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"email\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"nisi33b\": \"ut non eu\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"nulla7\": \"do Lorem\"\n },\n \"consent_text\": \"\"\n }\n ],\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"elit__62\": 50989265.128887475,\n \"eu2f\": -63495711,\n \"Lorem55d\": -15674876,\n \"dolor77f\": false\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"nisi_4\": 91791283,\n \"Duis5\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\",\n \"channel\": \"sms\",\n \"resource_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-f147a149-3620-4cdc-95b9-c910c87e4830" }, { "id": "09403701-a9cc-4db0-926e-12325742189b", "name": "Validation error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"email\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"nisi33b\": \"ut non eu\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"nulla7\": \"do Lorem\"\n },\n \"consent_text\": \"\"\n }\n ],\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"elit__62\": 50989265.128887475,\n \"eu2f\": -63495711,\n \"Lorem55d\": -15674876,\n \"dolor77f\": false\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"nisi_4\": 91791283,\n \"Duis5\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\",\n \"channel\": \"sms\",\n \"resource_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-09403701-a9cc-4db0-926e-12325742189b" }, { "id": "9fc201d9-9a7e-49a1-a2e8-d0899ea6a09c", "name": "Rate limited", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"description\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"email\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"nisi33b\": \"ut non eu\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"nulla7\": \"do Lorem\"\n },\n \"consent_text\": \"\"\n }\n ],\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"elit__62\": 50989265.128887475,\n \"eu2f\": -63495711,\n \"Lorem55d\": -15674876,\n \"dolor77f\": false\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"nisi_4\": 91791283,\n \"Duis5\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\",\n \"channel\": \"sms\",\n \"resource_type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-9fc201d9-9a7e-49a1-a2e8-d0899ea6a09c" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-25826fe7-4705-4ddf-8ee5-cf9633bcca9b" }, { "name": "Archive (soft-delete) a surface", "id": "84e583d7-4566-464d-992a-15e7a8be1bdd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "id": "4fc91063-6b0f-4d8d-99e9-9830a16b564d", "key": "workspace_id", "value": "", "description": "(Required) " }, { "id": "3d1710c1-a600-4f69-b3df-f66096d8b140", "key": "surface_id", "value": "", "description": "(Required) " } ] }, "description": "Archive (soft-delete) a surface.\n\nWorks for any non-terminal surface. Terminal surfaces (completed,\nexpired, already archived) cannot be archived.\n\nPermissions: member, admin, owner (Surface:Create)" }, "response": [ { "id": "8ee00e49-dd41-445f-9764-8464d02889c1", "name": "Successful Response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"surface_id\": \"\",\n \"status\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-8ee00e49-dd41-445f-9764-8464d02889c1" }, { "id": "f1548331-7d60-4dd0-b6c4-a66a114d5f0e", "name": "Surface not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-f1548331-7d60-4dd0-b6c4-a66a114d5f0e" }, { "id": "206e351d-22d9-46f8-85ab-d54a7a333359", "name": "Cannot archive terminal surface", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-206e351d-22d9-46f8-85ab-d54a7a333359" }, { "id": "64c03604-27e2-483e-8f1e-b3a4f3958aab", "name": "Validation Error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-64c03604-27e2-483e-8f1e-b3a4f3958aab" }, { "id": "03287640-739a-4467-9457-8774bb91dbf4", "name": "Rate limited", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces/:surface_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces", ":surface_id" ], "variable": [ { "key": "workspace_id" }, { "key": "surface_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-03287640-739a-4467-9457-8774bb91dbf4" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-84e583d7-4566-464d-992a-15e7a8be1bdd" } ], "id": "e850ad15-efa7-46c4-8f16-d32d252a3b4f", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-e850ad15-efa7-46c4-8f16-d32d252a3b4f" }, { "name": "Create Surface", "id": "ad05a09b-ea43-46d9-a57d-a42d6876cfbd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"\",\n \"title\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"multiselect\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"elit_851\": \"sed\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"commodo_3\": 15677194\n },\n \"consent_text\": \"\"\n }\n ],\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"expires_in_hours\": 168,\n \"context\": {},\n \"resource_type\": \"\",\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"sint_f0\": \"quis fugiat esse dolore\",\n \"et_0b\": \"elit proident\"\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"dolorb\": true,\n \"veniam16\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "variable": [ { "id": "049abd86-5baa-48e8-b292-e6889e0b676a", "key": "workspace_id", "value": "", "description": "(Required) " } ] }, "description": "Create a new data collection surface.\n\nStores the surface spec as a world.event with domain=\"surface\".\nThe entity_id is stored inside event data (not on the event row)\nto avoid entity state recomputation.\n\nReturns a signed patient-facing token and URL if SURFACE_TOKEN_SECRET is configured.\n\nPermissions: member, admin, owner (surfaces:write)" }, "response": [ { "id": "b8093ab1-5639-465c-932d-c740be3b3de2", "name": "Successful Response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"\",\n \"title\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"multiselect\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"elit_851\": \"sed\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"commodo_3\": 15677194\n },\n \"consent_text\": \"\"\n }\n ],\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"expires_in_hours\": 168,\n \"context\": {},\n \"resource_type\": \"\",\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"sint_f0\": \"quis fugiat esse dolore\",\n \"et_0b\": \"elit proident\"\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"dolorb\": true,\n \"veniam16\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "variable": [ { "key": "workspace_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"event_id\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"status\": \"opened\",\n \"channel\": \"sms\",\n \"fields_count\": \"\",\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"description\": \"\",\n \"use_case_id\": \"\",\n \"token\": \"\",\n \"url\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-b8093ab1-5639-465c-932d-c740be3b3de2" }, { "id": "95069ece-0830-4c03-8ad1-a9caa025a124", "name": "Validation error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"\",\n \"title\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"multiselect\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"elit_851\": \"sed\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"commodo_3\": 15677194\n },\n \"consent_text\": \"\"\n }\n ],\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"expires_in_hours\": 168,\n \"context\": {},\n \"resource_type\": \"\",\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"sint_f0\": \"quis fugiat esse dolore\",\n \"et_0b\": \"elit proident\"\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"dolorb\": true,\n \"veniam16\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-95069ece-0830-4c03-8ad1-a9caa025a124" }, { "id": "99577556-5bde-41b2-bb04-d2a93e1c1bb3", "name": "Rate limited", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"entity_id\": \"\",\n \"title\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"field_type\": \"multiselect\",\n \"required\": true,\n \"options\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"placeholder\": \"\",\n \"prefill_value\": {},\n \"validation\": {\n \"elit_851\": \"sed\"\n },\n \"sensitive\": false,\n \"condition\": {\n \"commodo_3\": 15677194\n },\n \"consent_text\": \"\"\n }\n ],\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"expires_in_hours\": 168,\n \"context\": {},\n \"resource_type\": \"\",\n \"branding\": {\n \"logo_url\": \"\",\n \"primary_color\": \"\",\n \"background_color\": \"\",\n \"font_family\": \"\"\n },\n \"sections\": [\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"sint_f0\": \"quis fugiat esse dolore\",\n \"et_0b\": \"elit proident\"\n }\n },\n {\n \"title\": \"\",\n \"field_keys\": [\n \"\"\n ],\n \"description\": \"\",\n \"condition\": {\n \"dolorb\": true,\n \"veniam16\": false\n }\n }\n ],\n \"completion_title\": \"\",\n \"completion_message\": \"\",\n \"completion_action_url\": \"\",\n \"submit_button_text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-99577556-5bde-41b2-bb04-d2a93e1c1bb3" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-ad05a09b-ea43-46d9-a57d-a42d6876cfbd" }, { "name": "List Surfaces", "id": "408b5500-a0f7-4233-a20f-b7a580d65ff6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces?entity_id=&status=&channel=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "query": [ { "description": "Filter by entity ID", "key": "entity_id", "value": "" }, { "description": "Filter by status", "key": "status", "value": "" }, { "description": "Filter by channel", "key": "channel", "value": "" }, { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "id": "e11437ba-8a02-4434-9a38-d6129b05fc3d", "key": "workspace_id", "value": "", "description": "(Required) " } ] }, "description": "List surfaces with pagination and optional filters.\n\nPermissions: viewer, member, admin, owner (surfaces:read)" }, "response": [ { "id": "a0668682-8025-4f06-8818-9d87da1cbd58", "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces?entity_id=&status=&channel=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "query": [ { "description": "Filter by entity ID", "key": "entity_id", "value": "" }, { "description": "Filter by status", "key": "status", "value": "" }, { "description": "Filter by channel", "key": "channel", "value": "" }, { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"status\": \"opened\",\n \"fields_count\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"resource_type\": \"\",\n \"context\": {},\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"opened_at\": \"\",\n \"submitted_at\": \"\",\n \"submitted_data\": {\n \"Lorem_b_f\": \"dolore enim\",\n \"quis8_\": false\n },\n \"delivery_metadata\": {\n \"irure_928\": true,\n \"magna_2\": 23114794.6979903\n },\n \"review_notes\": \"\",\n \"reviewed_by\": \"\",\n \"reviewed_at\": \"\",\n \"archived_at\": \"\",\n \"archive_reason\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"event_id\": \"\",\n \"status\": \"partial\",\n \"fields_count\": \"\",\n \"entity_id\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"channel\": \"email\",\n \"use_case_id\": \"\",\n \"resource_type\": \"\",\n \"context\": {},\n \"expires_at\": \"\",\n \"created_at\": \"\",\n \"delivered_at\": \"\",\n \"opened_at\": \"\",\n \"submitted_at\": \"\",\n \"submitted_data\": {\n \"amet3\": true,\n \"sed_2\": -83162128.46480569,\n \"occaecat4\": true,\n \"culpade6\": 54217128\n },\n \"delivery_metadata\": {\n \"irure_b\": true\n },\n \"review_notes\": \"\",\n \"reviewed_by\": \"\",\n \"reviewed_at\": \"\",\n \"archived_at\": \"\",\n \"archive_reason\": \"\",\n \"url\": \"\"\n }\n ],\n \"has_more\": \"\",\n \"continuation_token\": \"\",\n \"total\": \"\"\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-a0668682-8025-4f06-8818-9d87da1cbd58" }, { "id": "fae097b4-a43b-47eb-afd7-6b544b9f567c", "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces?entity_id=&status=&channel=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "query": [ { "description": "Filter by entity ID", "key": "entity_id", "value": "" }, { "description": "Filter by status", "key": "status", "value": "" }, { "description": "Filter by channel", "key": "channel", "value": "" }, { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"detail\": [\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n },\n {\n \"loc\": [\n \"\",\n \"\"\n ],\n \"msg\": \"\",\n \"type\": \"\",\n \"input\": {\n \"title\": \"Input\"\n },\n \"ctx\": {}\n }\n ]\n}", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-fae097b4-a43b-47eb-afd7-6b544b9f567c" }, { "id": "a001aa45-d5cb-48a0-a9eb-79fb2736578e", "name": "Rate limited", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/:workspace_id/surfaces?entity_id=&status=&channel=&limit=10&continuation_token=0", "host": [ "{{baseUrl}}" ], "path": [ "v1", ":workspace_id", "surfaces" ], "query": [ { "description": "Filter by entity ID", "key": "entity_id", "value": "" }, { "description": "Filter by status", "key": "status", "value": "" }, { "description": "Filter by channel", "key": "channel", "value": "" }, { "key": "limit", "value": "10" }, { "key": "continuation_token", "value": "0" } ], "variable": [ { "key": "workspace_id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-a001aa45-d5cb-48a0-a9eb-79fb2736578e" } ], "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-408b5500-a0f7-4233-a20f-b7a580d65ff6" } ], "id": "468b0781-6910-4b49-b7d3-4bc4b0a26f67", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-468b0781-6910-4b49-b7d3-4bc4b0a26f67" } ], "id": "31e1cdc3-2013-42d2-899f-6ca4c71c41ce", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-31e1cdc3-2013-42d2-899f-6ca4c71c41ce" } ], "id": "cf9c942e-1461-48b7-8464-11c0542537c8", "createdAt": "2026-07-28T01:02:52.000Z", "updatedAt": "2026-07-28T01:02:52.000Z", "uid": "35240-cf9c942e-1461-48b7-8464-11c0542537c8" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.amigo.ai" } ] }