{ "info": { "_postman_id": "c863f651-0c05-47d0-8d9b-5b40de1847ef", "name": "Knock Users API", "description": "Identify, list, update, delete, and merge users plus manage their channel data, preferences, in-app feeds, guides, subscriptions, messages, and schedules. The primary recipient surface for Knock.\n\nContact Support:\n Name: Knock", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:10:14.000Z", "updatedAt": "2026-06-05T15:10:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-c863f651-0c05-47d0-8d9b-5b40de1847ef" }, "item": [ { "name": "v1", "item": [ { "name": "users", "item": [ { "name": "{user_id}", "item": [ { "name": "guides", "item": [ { "name": "messages", "item": [ { "name": "seen", "item": [ { "name": "Mark guide as seen", "id": "a42bec10-d77a-4d1a-b650-b3aef556dbd8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/seen", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "seen" ], "variable": [ { "id": "c647c2d3-f046-4da5-bc83-921199342169", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Records that a guide has been seen by a user, triggering any associated seen events." }, "response": [ { "id": "f20dd396-3e57-48a3-99f3-1eb03f5cadab", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/seen", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "seen" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-f20dd396-3e57-48a3-99f3-1eb03f5cadab" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a42bec10-d77a-4d1a-b650-b3aef556dbd8" } ], "id": "6c4c8e32-ae59-4867-916e-e7d0d6be8ce0", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-6c4c8e32-ae59-4867-916e-e7d0d6be8ce0" }, { "name": "{message_id}", "item": [ { "name": "seen", "item": [ { "name": "Mark guide as seen", "id": "c7aa7035-d72c-4ed5-b1a4-049e6df867f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/:message_id/seen", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", ":message_id", "seen" ], "variable": [ { "id": "6d6ea063-e15c-4af3-a659-222524babaf9", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "f6fc696c-7994-459b-8b7e-ffbf9e043d52", "key": "message_id" } ] }, "description": "Records that a guide has been seen by a user, triggering any associated seen events." }, "response": [ { "id": "f66e8388-4fb2-4d6a-a1e7-56b2287e7658", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/:message_id/seen", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", ":message_id", "seen" ], "variable": [ { "key": "user_id" }, { "key": "message_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-f66e8388-4fb2-4d6a-a1e7-56b2287e7658" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-c7aa7035-d72c-4ed5-b1a4-049e6df867f0" } ], "id": "622cdbfa-b964-44c2-89a4-9024f718b1f0", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-622cdbfa-b964-44c2-89a4-9024f718b1f0" }, { "name": "interacted", "item": [ { "name": "Mark guide as interacted", "id": "3d1aaba1-39e4-47d8-a1ba-d496a647abea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/:message_id/interacted", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", ":message_id", "interacted" ], "variable": [ { "id": "b2825dc7-b6ba-436d-9321-e11c2661a828", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "e63391eb-e60e-4d8d-b11c-d96fd72874eb", "key": "message_id" } ] }, "description": "Records that a user has interacted with a guide, triggering any associated interacted events." }, "response": [ { "id": "9eacffe7-65cf-4fa5-91c6-79154e43a91c", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/:message_id/interacted", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", ":message_id", "interacted" ], "variable": [ { "key": "user_id" }, { "key": "message_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-9eacffe7-65cf-4fa5-91c6-79154e43a91c" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-3d1aaba1-39e4-47d8-a1ba-d496a647abea" } ], "id": "0e320647-fee0-4b46-859d-65e5b9f8113a", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0e320647-fee0-4b46-859d-65e5b9f8113a" }, { "name": "archived", "item": [ { "name": "Mark guide as archived", "id": "84885fe5-4152-401b-969c-18d9798bf4c5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/:message_id/archived", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", ":message_id", "archived" ], "variable": [ { "id": "03808639-c483-4758-a958-4b9303792c35", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "d10b4f12-dea8-4d42-af4f-ffa730b928a0", "key": "message_id" } ] }, "description": "Records that a guide has been archived by a user, triggering any associated archived events." }, "response": [ { "id": "8e433759-09cf-41a8-8ecf-1e0a73f16fb5", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/:message_id/archived", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", ":message_id", "archived" ], "variable": [ { "key": "user_id" }, { "key": "message_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-8e433759-09cf-41a8-8ecf-1e0a73f16fb5" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-84885fe5-4152-401b-969c-18d9798bf4c5" } ], "id": "53cd2e62-5e2d-4c6b-8c22-e8d3008ffdb7", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-53cd2e62-5e2d-4c6b-8c22-e8d3008ffdb7" } ], "id": "c992302e-d541-45e6-8da1-8499daae1461", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-c992302e-d541-45e6-8da1-8499daae1461" }, { "name": "archived", "item": [ { "name": "Mark guide as unarchived", "id": "7fd6cb89-955c-4567-843e-c6b842d01842", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/archived", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "archived" ], "variable": [ { "id": "c395271d-23fd-4e32-89b3-ff6ef4380343", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Records that a guide has been unarchived, triggering any associated unarchived events." }, "response": [ { "id": "a494c779-4b62-4af3-9378-28c784c2c53e", "name": "OK", "originalRequest": { "method": "DELETE", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/archived", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "archived" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a494c779-4b62-4af3-9378-28c784c2c53e" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-7fd6cb89-955c-4567-843e-c6b842d01842" }, { "name": "Mark guide as archived", "id": "788f7e64-dfe7-4476-9786-478f85d2c217", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/archived", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "archived" ], "variable": [ { "id": "14362c89-d49d-45a1-b6d1-3cbab62ed823", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Records that a guide has been archived by a user, triggering any associated archived events." }, "response": [ { "id": "3a580877-5325-4876-b916-15ab58088528", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/archived", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "archived" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-3a580877-5325-4876-b916-15ab58088528" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-788f7e64-dfe7-4476-9786-478f85d2c217" } ], "id": "7a5e2796-d570-4657-ab05-28b2a5f33a9c", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-7a5e2796-d570-4657-ab05-28b2a5f33a9c" }, { "name": "interacted", "item": [ { "name": "Mark guide as interacted", "id": "85b55eae-9cbe-4a4b-b784-093ed3a9fa99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/interacted", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "interacted" ], "variable": [ { "id": "34edb00b-1daa-47a9-8d65-6f1833014015", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Records that a user has interacted with a guide, triggering any associated interacted events." }, "response": [ { "id": "ae6cca22-b8c6-46da-9216-800c9a214112", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/messages/interacted", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "messages", "interacted" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-ae6cca22-b8c6-46da-9216-800c9a214112" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-85b55eae-9cbe-4a4b-b784-093ed3a9fa99" } ], "id": "870229b6-a1b0-40a9-978c-23987b9fe31b", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-870229b6-a1b0-40a9-978c-23987b9fe31b" } ], "id": "d16f95c4-9885-4647-af5b-db652e68e6eb", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-d16f95c4-9885-4647-af5b-db652e68e6eb" }, { "name": "engagements", "item": [ { "name": "reset", "item": [ { "name": "Reset guide engagement", "id": "f7d006df-c23c-45cb-9805-53a2e3a7fe51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/engagements/reset", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "engagements", "reset" ], "variable": [ { "id": "8f48841a-1832-4615-b447-c5b6eaca2cd4", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Resets the engagement state of a guide for a user, removing the guide's engagement log entry so the next interaction creates a fresh engagement." }, "response": [ { "id": "d5ec9528-abb9-44b3-99cc-fdf96f6b8181", "name": "OK", "originalRequest": { "method": "PUT", "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_id\": \"\",\n \"guide_id\": \"\",\n \"guide_key\": \"\",\n \"guide_step_ref\": \"\",\n \"content\": {\n \"Ut_6\": \"ea nisi in\"\n },\n \"data\": {\n \"amet_654\": false\n },\n \"is_final\": \"\",\n \"metadata\": {\n \"labore_427\": -16648409.0814147\n },\n \"tenant\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/engagements/reset", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", "engagements", "reset" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-d5ec9528-abb9-44b3-99cc-fdf96f6b8181" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-f7d006df-c23c-45cb-9805-53a2e3a7fe51" } ], "id": "799774b7-2e27-47d5-b86f-f19ca8636e06", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-799774b7-2e27-47d5-b86f-f19ca8636e06" } ], "id": "af904cec-7db1-4da0-8361-9ac579d205b1", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-af904cec-7db1-4da0-8361-9ac579d205b1" }, { "name": "{channel_id}", "item": [ { "name": "List guides", "id": "7c2886f7-937d-4249-84b8-9fcecd0832d9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/guides/:channel_id?tenant=&data=&type=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", ":channel_id" ], "query": [ { "description": "The tenant ID to use for targeting and rendering guides.", "key": "tenant", "value": "" }, { "description": "The data (JSON encoded object) to use for targeting and rendering guides.", "key": "data", "value": "" }, { "description": "The type of guides to filter by.", "key": "type", "value": "" } ], "variable": [ { "id": "28ed8da5-aff6-44ec-ab23-c02d85ce69ed", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "2e150c45-5694-4d0a-8089-594d0a76921d", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Returns a list of eligible in-app guides for a specific user and channel." }, "response": [ { "id": "67a2ddd9-0cd7-4aa7-adb0-74b843c839d2", "name": "OK", "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/users/:user_id/guides/:channel_id?tenant=&data=&type=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "guides", ":channel_id" ], "query": [ { "description": "The tenant ID to use for targeting and rendering guides.", "key": "tenant", "value": "" }, { "description": "The data (JSON encoded object) to use for targeting and rendering guides.", "key": "data", "value": "" }, { "description": "The type of guides to filter by.", "key": "type", "value": "" } ], "variable": [ { "key": "user_id" }, { "key": "channel_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"__typename\": \"\",\n \"activation_url_patterns\": [\n {\n \"directive\": \"\",\n \"pathname\": \"\",\n \"search\": \"\"\n },\n {\n \"directive\": \"\",\n \"pathname\": \"\",\n \"search\": \"\"\n }\n ],\n \"activation_url_rules\": [\n {\n \"argument\": \"\",\n \"directive\": \"\",\n \"operator\": \"\",\n \"variable\": \"\"\n },\n {\n \"argument\": \"\",\n \"directive\": \"\",\n \"operator\": \"\",\n \"variable\": \"\"\n }\n ],\n \"active\": \"\",\n \"bypass_global_group_limit\": \"\",\n \"channel_id\": \"\",\n \"dashboard_url\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"key\": \"\",\n \"semver\": \"\",\n \"steps\": [\n {\n \"content\": {\n \"esse__4\": \"aute eu labore\",\n \"ea_530\": 59267908\n },\n \"message\": {\n \"archived_at\": \"\",\n \"id\": \"\",\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"read_at\": \"\",\n \"seen_at\": \"\"\n },\n \"ref\": \"\",\n \"schema_key\": \"\",\n \"schema_semver\": \"\",\n \"schema_variant_key\": \"\"\n },\n {\n \"content\": {\n \"eiusmod_470\": 40250753.89989278,\n \"minimb36\": -54774137\n },\n \"message\": {\n \"archived_at\": \"\",\n \"id\": \"\",\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"read_at\": \"\",\n \"seen_at\": \"\"\n },\n \"ref\": \"\",\n \"schema_key\": \"\",\n \"schema_semver\": \"\",\n \"schema_variant_key\": \"\"\n }\n ],\n \"type\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"__typename\": \"\",\n \"activation_url_patterns\": [\n {\n \"directive\": \"\",\n \"pathname\": \"\",\n \"search\": \"\"\n },\n {\n \"directive\": \"\",\n \"pathname\": \"\",\n \"search\": \"\"\n }\n ],\n \"activation_url_rules\": [\n {\n \"argument\": \"\",\n \"directive\": \"\",\n \"operator\": \"\",\n \"variable\": \"\"\n },\n {\n \"argument\": \"\",\n \"directive\": \"\",\n \"operator\": \"\",\n \"variable\": \"\"\n }\n ],\n \"active\": \"\",\n \"bypass_global_group_limit\": \"\",\n \"channel_id\": \"\",\n \"dashboard_url\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"key\": \"\",\n \"semver\": \"\",\n \"steps\": [\n {\n \"content\": {\n \"veniam__56\": 62649106,\n \"tempor_b6\": -86536857.89584693\n },\n \"message\": {\n \"archived_at\": \"\",\n \"id\": \"\",\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"read_at\": \"\",\n \"seen_at\": \"\"\n },\n \"ref\": \"\",\n \"schema_key\": \"\",\n \"schema_semver\": \"\",\n \"schema_variant_key\": \"\"\n },\n {\n \"content\": {\n \"commodo_0\": \"veniam mollit\",\n \"magna29\": 90653349.85633418,\n \"eu6b4\": -29570758\n },\n \"message\": {\n \"archived_at\": \"\",\n \"id\": \"\",\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"read_at\": \"\",\n \"seen_at\": \"\"\n },\n \"ref\": \"\",\n \"schema_key\": \"\",\n \"schema_semver\": \"\",\n \"schema_variant_key\": \"\"\n }\n ],\n \"type\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"guide_groups\": [\n {\n \"__typename\": \"\",\n \"display_interval\": \"\",\n \"display_sequence\": [\n \"\",\n \"\"\n ],\n \"inserted_at\": \"\",\n \"key\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"__typename\": \"\",\n \"display_interval\": \"\",\n \"display_sequence\": [\n \"\",\n \"\"\n ],\n \"inserted_at\": \"\",\n \"key\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"guide_group_display_logs\": {\n \"ut_\": \"\",\n \"nisi_74\": \"\",\n \"eiusmodbc\": \"\",\n \"officia8\": \"\"\n },\n \"ineligible_guides\": [\n {\n \"key\": \"\",\n \"reason\": \"marked_as_archived\",\n \"message\": \"\"\n },\n {\n \"key\": \"\",\n \"reason\": \"marked_as_archived\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-67a2ddd9-0cd7-4aa7-adb0-74b843c839d2" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-7c2886f7-937d-4249-84b8-9fcecd0832d9" } ], "id": "150cc076-eef8-4c99-83d6-cdd45e6aac74", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-150cc076-eef8-4c99-83d6-cdd45e6aac74" } ], "id": "dfc7c2e7-2597-4355-b139-112fe6834dab", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-dfc7c2e7-2597-4355-b139-112fe6834dab" }, { "name": "feeds", "item": [ { "name": "{id}", "item": [ { "name": "settings", "item": [ { "name": "Get feed settings", "id": "b9835b7d-c310-4eca-9045-5931eadef1e4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/feeds/:id/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "feeds", ":id", "settings" ], "variable": [ { "id": "fe8a0f6d-80c8-489e-960c-476dfef26c53", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "58338b88-0686-484b-b090-dda53de32887", "key": "id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Returns the feed settings for a user." }, "response": [ { "id": "51bf1f44-ad0e-43ba-af6b-d87a462ed0fc", "name": "OK", "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/users/:user_id/feeds/:id/settings", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "feeds", ":id", "settings" ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"features\": {\n \"branding_required\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-51bf1f44-ad0e-43ba-af6b-d87a462ed0fc" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-b9835b7d-c310-4eca-9045-5931eadef1e4" } ], "id": "af30bd05-c737-4015-93c9-d374e4e64aa5", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-af30bd05-c737-4015-93c9-d374e4e64aa5" }, { "name": "List feed items", "id": "94ab247b-7b59-42b9-868a-3800e8307ad0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/feeds/:id?status=read&source=&tenant=&has_tenant=&workflow_categories[]=&workflow_categories[]=&archived=only&trigger_data=&locale=&exclude=&mode=rich&after=&before=&page_size=&inserted_at.gt=&inserted_at.gte=&inserted_at.lt=&inserted_at.lte=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "feeds", ":id" ], "query": [ { "description": "The status of the feed items.", "key": "status", "value": "read" }, { "description": "The workflow key associated with the message in the feed.", "key": "source", "value": "" }, { "description": "The tenant associated with the feed items.", "key": "tenant", "value": "" }, { "description": "Whether the feed items have a tenant.", "key": "has_tenant", "value": "" }, { "description": "The workflow categories of the feed items.", "key": "workflow_categories[]", "value": "" }, { "description": "The workflow categories of the feed items.", "key": "workflow_categories[]", "value": "" }, { "description": "The archived status of the feed items.", "key": "archived", "value": "only" }, { "description": "The trigger data of the feed items (as a JSON string).", "key": "trigger_data", "value": "" }, { "description": "The locale to render the feed items in. Must be in the IETF 5646 format (e.g. `en-US`). When not provided, will default to the locale that the feed items were rendered in. Only available for enterprise plan customers using custom translations.", "key": "locale", "value": "" }, { "description": "Comma-separated list of field paths to exclude from the response. Use dot notation for nested fields (e.g., `entries.archived_at`). Limited to 3 levels deep.", "key": "exclude", "value": "" }, { "description": "The mode to render the feed items in. Can be `compact` or `rich`. Defaults to `rich`. When `mode` is `compact`, feed items will not have `activities` and `total_activities` fields; the `data` field will not include nested arrays and objects; and the `actors` field will only have up to one actor.", "key": "mode", "value": "rich" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" }, { "description": "Limits the results to items inserted after the given date.", "key": "inserted_at.gt", "value": "" }, { "description": "Limits the results to items inserted after or on the given date.", "key": "inserted_at.gte", "value": "" }, { "description": "Limits the results to items inserted before the given date.", "key": "inserted_at.lt", "value": "" }, { "description": "Limits the results to items inserted before or on the given date.", "key": "inserted_at.lte", "value": "" } ], "variable": [ { "id": "10469a07-27f9-4a65-8965-354656c1f6fe", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "fe4c0be6-918c-4f22-ad8e-8a175e6c2add", "key": "id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Returns a paginated list of feed items for a user in reverse chronological order, including metadata about the feed. If the user has not yet been identified within Knock, an empty feed will be returned.\n\nYou can customize the response using [response filters](/integrations/in-app/knock#customizing-api-response-content) to exclude or only include specific properties on your resources.\n\n**Notes:**\n* When making this call from a client-side environment, use your publishable key along with a user token.\n* This endpoint\u2019s rate limit is always scoped per-user and per-environment. This is true even for requests made without a signed user token.\n* Any [attachments](/integrations/email/attachments) present in trigger data are automatically excluded from both the `data` and `activities` fields of `UserInAppFeedResponse`.\n" }, "response": [ { "id": "cb068de8-2799-4fd8-b00d-0ea4611244fe", "name": "OK", "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/users/:user_id/feeds/:id?status=read&source=&tenant=&has_tenant=&workflow_categories[]=&archived=only&trigger_data=&locale=&exclude=&mode=rich&after=&before=&page_size=&inserted_at.gt=&inserted_at.gte=&inserted_at.lt=&inserted_at.lte=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "feeds", ":id" ], "query": [ { "description": "The status of the feed items.", "key": "status", "value": "read" }, { "description": "The workflow key associated with the message in the feed.", "key": "source", "value": "" }, { "description": "The tenant associated with the feed items.", "key": "tenant", "value": "" }, { "description": "Whether the feed items have a tenant.", "key": "has_tenant", "value": "" }, { "description": "The workflow categories of the feed items.", "key": "workflow_categories[]", "value": "" }, { "description": "The archived status of the feed items.", "key": "archived", "value": "only" }, { "description": "The trigger data of the feed items (as a JSON string).", "key": "trigger_data", "value": "" }, { "description": "The locale to render the feed items in. Must be in the IETF 5646 format (e.g. `en-US`). When not provided, will default to the locale that the feed items were rendered in. Only available for enterprise plan customers using custom translations.", "key": "locale", "value": "" }, { "description": "Comma-separated list of field paths to exclude from the response. Use dot notation for nested fields (e.g., `entries.archived_at`). Limited to 3 levels deep.", "key": "exclude", "value": "" }, { "description": "The mode to render the feed items in. Can be `compact` or `rich`. Defaults to `rich`. When `mode` is `compact`, feed items will not have `activities` and `total_activities` fields; the `data` field will not include nested arrays and objects; and the `actors` field will only have up to one actor.", "key": "mode", "value": "rich" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" }, { "description": "Limits the results to items inserted after the given date.", "key": "inserted_at.gt", "value": "" }, { "description": "Limits the results to items inserted after or on the given date.", "key": "inserted_at.gte", "value": "" }, { "description": "Limits the results to items inserted before the given date.", "key": "inserted_at.lt", "value": "" }, { "description": "Limits the results to items inserted before or on the given date.", "key": "inserted_at.lte", "value": "" } ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"actors\": [\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n }\n ],\n \"activities\": [\n {\n \"__typename\": \"\",\n \"actor\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"data\": {\n \"sint_b7\": \"ex elit non\",\n \"dolor9\": 8017610.866704807,\n \"quis17\": false,\n \"Duis_\": true\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"updated_at\": \"\"\n },\n {\n \"__typename\": \"\",\n \"actor\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"data\": {\n \"consectetur_63b\": \"eiusmod elit minim\"\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"updated_at\": \"\"\n }\n ],\n \"blocks\": [\n {\n \"type\": \"markdown\",\n \"name\": \"\",\n \"rendered\": \"\",\n \"content\": \"\"\n },\n {\n \"type\": \"markdown\",\n \"name\": \"\",\n \"rendered\": \"\",\n \"content\": \"\"\n }\n ],\n \"source\": {\n \"__typename\": \"\",\n \"key\": \"\",\n \"version_id\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ]\n },\n \"tenant\": \"\",\n \"total_activities\": \"\",\n \"total_actors\": \"\",\n \"data\": {\n \"minim6c\": 82111074.25490901,\n \"aute47\": 60586778\n },\n \"archived_at\": \"\",\n \"clicked_at\": \"\",\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"read_at\": \"\",\n \"seen_at\": \"\"\n },\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"actors\": [\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n }\n ],\n \"activities\": [\n {\n \"__typename\": \"\",\n \"actor\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"data\": {\n \"Loremf_\": -91254027.86406456,\n \"est99c\": \"laborum ea\",\n \"elitcc\": false\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"updated_at\": \"\"\n },\n {\n \"__typename\": \"\",\n \"actor\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"data\": {\n \"aliquip_19\": -57244568.11375713,\n \"amet_bb\": 23433528.774682388,\n \"do_b70\": -99432328.94740221\n },\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"updated_at\": \"\"\n }\n ],\n \"blocks\": [\n {\n \"type\": \"markdown\",\n \"name\": \"\",\n \"rendered\": \"\",\n \"content\": \"\"\n },\n {\n \"type\": \"text\",\n \"name\": \"\",\n \"rendered\": \"\",\n \"content\": \"\"\n }\n ],\n \"source\": {\n \"__typename\": \"\",\n \"key\": \"\",\n \"version_id\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ]\n },\n \"tenant\": \"\",\n \"total_activities\": \"\",\n \"total_actors\": \"\",\n \"data\": {\n \"labore_6a5\": false\n },\n \"archived_at\": \"\",\n \"clicked_at\": \"\",\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"read_at\": \"\",\n \"seen_at\": \"\"\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n },\n \"vars\": {\n \"Loremf\": -69234051,\n \"irure2b\": true\n },\n \"meta\": {\n \"__typename\": \"\",\n \"total_count\": \"\",\n \"unread_count\": \"\",\n \"unseen_count\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-cb068de8-2799-4fd8-b00d-0ea4611244fe" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-94ab247b-7b59-42b9-868a-3800e8307ad0" } ], "id": "bc89f571-65cd-463a-b875-f100d83a8860", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-bc89f571-65cd-463a-b875-f100d83a8860" } ], "id": "91e9daae-a94c-4bb1-9346-4ffbbb400bc3", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-91e9daae-a94c-4bb1-9346-4ffbbb400bc3" }, { "name": "subscriptions", "item": [ { "name": "List user subscriptions", "id": "6ec44be1-c1db-4a4a-b3ff-6295d71a8a38", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/subscriptions?include[]=preferences&include[]=preferences&objects[]=&objects[]=&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "subscriptions" ], "query": [ { "description": "Associated resources to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Associated resources to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Only returns subscriptions for the specified object references.", "key": "objects[]", "value": "" }, { "description": "Only returns subscriptions for the specified object references.", "key": "objects[]", "value": "" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" } ], "variable": [ { "id": "ac738a48-50ca-4b03-b42e-3731772b2899", "key": "user_id", "value": "", "description": "(Required) The user ID to list subscriptions for." } ] }, "description": "Retrieves a paginated list of subscriptions for a specific user, in descending order." }, "response": [ { "id": "a5681d4f-c376-4c92-bd69-655709d609e1", "name": "OK", "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/users/:user_id/subscriptions?include[]=preferences&objects[]=&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "subscriptions" ], "query": [ { "description": "Associated resources to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Only returns subscriptions for the specified object references.", "key": "objects[]", "value": "" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"__typename\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"object\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"collection\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"properties\": {\n \"proident_f76\": 77993667.47252688\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"dolor_0\": false\n }\n },\n {\n \"__typename\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"object\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"collection\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"properties\": {\n \"nisi_7\": -18113181,\n \"eu07\": \"Excepteur non elit Lorem ipsum\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"sintb1\": -50786036,\n \"mollitd8\": 69316292\n }\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a5681d4f-c376-4c92-bd69-655709d609e1" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-6ec44be1-c1db-4a4a-b3ff-6295d71a8a38" } ], "id": "deeffd88-da8f-4c98-8ce3-6edd56b9169c", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-deeffd88-da8f-4c98-8ce3-6edd56b9169c" }, { "name": "preferences", "item": [ { "name": "{id}", "item": [ { "name": "categories", "item": [ { "name": "{key}", "item": [ { "name": "Update category in user preference set", "id": "64d9053d-353d-4909-b9cc-9b174a93b693", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/categories/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "categories", ":key" ], "variable": [ { "id": "d425ad53-8a97-4c4e-bce7-a296a3fdf9c0", "key": "user_id" }, { "id": "9d6a666d-d19d-4ac6-b369-45f9e242d409", "key": "id" }, { "id": "ce7b778b-e7ae-46b3-9459-478ba572e9ea", "key": "key" } ] }, "description": "Updates a single category in a specific user preference set. This operation is deprecated." }, "response": [ { "id": "ef397285-1e7a-4862-ba67-36700c684028", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/categories/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "categories", ":key" ], "variable": [ { "key": "user_id" }, { "key": "id" }, { "key": "key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-ef397285-1e7a-4862-ba67-36700c684028" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-64d9053d-353d-4909-b9cc-9b174a93b693" } ], "id": "2bbb66c8-bcf6-4964-bd92-68e8f11c24bd", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-2bbb66c8-bcf6-4964-bd92-68e8f11c24bd" }, { "name": "Update categories in user preference set", "id": "70280bfe-e95b-4de5-9539-1b304eff50ad", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "categories" ], "variable": [ { "id": "45f58071-285a-48a1-a82b-0b1724f58843", "key": "user_id" }, { "id": "710795bf-6cec-46e1-8f97-f891974e7d04", "key": "id" } ] }, "description": "Updates the categories in a specific user preference set. This operation is deprecated." }, "response": [ { "id": "6f70fc92-e553-40bf-a2a2-5dd160afbb1b", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "categories" ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-6f70fc92-e553-40bf-a2a2-5dd160afbb1b" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-70280bfe-e95b-4de5-9539-1b304eff50ad" } ], "id": "9b645a2e-c54f-4e96-b1d6-06ae7195ac3f", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-9b645a2e-c54f-4e96-b1d6-06ae7195ac3f" }, { "name": "workflows", "item": [ { "name": "{key}", "item": [ { "name": "Update workflow in user preference set", "id": "45662adb-8a58-4a6c-8b97-a52991db2bf3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/workflows/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "workflows", ":key" ], "variable": [ { "id": "9ead1d23-3886-4800-b21d-391482ffa4dd", "key": "user_id" }, { "id": "19b13ac3-bbc4-45f9-86d1-1f0e9aa35b05", "key": "id" }, { "id": "7c8a6e91-cb6b-4ec1-be29-367be2f0d5a1", "key": "key" } ] }, "description": "Updates a single workflow in a specific user preference set. This operation is deprecated." }, "response": [ { "id": "6e7fb082-fae2-42a5-b4c2-fc2f63bdb819", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/workflows/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "workflows", ":key" ], "variable": [ { "key": "user_id" }, { "key": "id" }, { "key": "key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-6e7fb082-fae2-42a5-b4c2-fc2f63bdb819" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-45662adb-8a58-4a6c-8b97-a52991db2bf3" } ], "id": "7aaa6c74-666b-4493-a014-799a4e74cb83", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-7aaa6c74-666b-4493-a014-799a4e74cb83" }, { "name": "Update workflows in preference set", "id": "86656188-3943-43f8-962f-fe9b6578bd2d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/workflows", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "workflows" ], "variable": [ { "id": "18a192ca-311b-4c79-aa1e-8fda5efabec2", "key": "user_id" }, { "id": "5faf634c-48fe-4f53-9cdf-ffbc73959729", "key": "id" } ] }, "description": "Updates the workflows in a specific user preference set. This operation is deprecated." }, "response": [ { "id": "99bb9ec2-ea68-4c9c-942b-d4fa193efd9f", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/workflows", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "workflows" ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-99bb9ec2-ea68-4c9c-942b-d4fa193efd9f" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-86656188-3943-43f8-962f-fe9b6578bd2d" } ], "id": "65e2fa70-e395-409a-9fa9-7721cd937296", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-65e2fa70-e395-409a-9fa9-7721cd937296" }, { "name": "channel_types", "item": [ { "name": "{type}", "item": [ { "name": "Update channel type in preference set", "id": "31bb686a-a641-4f52-9585-2020a621e400", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/channel_types/:type", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "channel_types", ":type" ], "variable": [ { "id": "99ef9433-edd6-4f39-8f72-a3d54150b863", "key": "user_id" }, { "id": "8faf692d-3450-4763-9669-b83e9c0df583", "key": "id" }, { "id": "d9862b8a-ed08-4c07-8e66-03111ecbb5d3", "key": "type" } ] }, "description": "Updates a single channel type in a specific user preference set. This operation is deprecated." }, "response": [ { "id": "488aef04-2e3d-4547-bac6-a15e08282379", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/channel_types/:type", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "channel_types", ":type" ], "variable": [ { "key": "user_id" }, { "key": "id" }, { "key": "type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-488aef04-2e3d-4547-bac6-a15e08282379" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-31bb686a-a641-4f52-9585-2020a621e400" } ], "id": "0a97d233-a2d7-4190-bb87-96baedf71c90", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0a97d233-a2d7-4190-bb87-96baedf71c90" }, { "name": "Update channel types in preference set", "id": "de2befaf-eb92-4fb9-b888-e1b16783d4a5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/channel_types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "channel_types" ], "variable": [ { "id": "3d83ea58-2365-417b-a005-1ff16c25b3de", "key": "user_id" }, { "id": "2474f25e-f979-42d8-8c16-065f9c57bef1", "key": "id" } ] }, "description": "Updates the channel types in a specific user preference set. This operation is deprecated." }, "response": [ { "id": "a0e4d219-d493-42dc-afcf-489cff3af6dc", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id/channel_types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id", "channel_types" ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a0e4d219-d493-42dc-afcf-489cff3af6dc" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-de2befaf-eb92-4fb9-b888-e1b16783d4a5" } ], "id": "3ff0cbdc-27c3-496e-a7d7-d1a65b7bb639", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-3ff0cbdc-27c3-496e-a7d7-d1a65b7bb639" }, { "name": "Delete user preference set", "id": "dc6bccd4-9433-45b8-a747-d42253893795", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id" ], "variable": [ { "id": "e1ebb80d-6400-48e4-88ed-6940850f3afe", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "1b267434-61cf-437d-bcef-ca66501fd5cb", "key": "id", "value": "default", "description": "(Required) Unique identifier for the preference set." } ] }, "description": "Unsets the preference set for the user, removing it entirely." }, "response": [ { "id": "ed052fe3-dc85-482e-b44e-61e586abebbe", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id" ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-ed052fe3-dc85-482e-b44e-61e586abebbe" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-dc6bccd4-9433-45b8-a747-d42253893795" }, { "name": "Get user preference set", "id": "5c3698ed-8e3a-4a16-8f0e-9c34c71ba568", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id?tenant=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id" ], "query": [ { "description": "The unique identifier for the tenant.", "key": "tenant", "value": "" } ], "variable": [ { "id": "ac7a2698-88e7-461f-88b3-6e47d065e9fb", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "7b055a12-99be-48c2-81ae-26e7523dd198", "key": "id", "value": "default", "description": "(Required) Unique identifier for the preference set." } ] }, "description": "Retrieves a specific preference set for a user identified by the preference set ID." }, "response": [ { "id": "c1c8f4d9-e7bd-4d99-8592-38ad4ef6ba66", "name": "OK", "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/users/:user_id/preferences/:id?tenant=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id" ], "query": [ { "description": "The unique identifier for the tenant.", "key": "tenant", "value": "" } ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-c1c8f4d9-e7bd-4d99-8592-38ad4ef6ba66" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-5c3698ed-8e3a-4a16-8f0e-9c34c71ba568" }, { "name": "Update user preference set", "id": "a001a1e6-07e1-4a74-8d69-96295f8fe880", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"ineb6\": \"\",\n \"deserunt729\": \"\",\n \"proident_05\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"consequat320\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"laborum1\": \"\",\n \"aliquip_aaf\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id" ], "variable": [ { "id": "97ca3161-96c2-4d94-81d9-cdad6c56686e", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "d8c0ec9e-6e5c-407c-912d-716adfdf0e77", "key": "id", "value": "default", "description": "(Required) Unique identifier for the preference set." } ] }, "description": "Updates a complete preference set for a user. By default, this is a destructive operation and will replace any existing preferences with the preferences given. Use '__persistence_strategy__': 'merge' to merge with existing preferences instead." }, "response": [ { "id": "b4ef3b10-7bc2-4a83-a9c5-580d67a537b7", "name": "OK", "originalRequest": { "method": "PUT", "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 \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"ineb6\": \"\",\n \"deserunt729\": \"\",\n \"proident_05\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"consequat320\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"laborum1\": \"\",\n \"aliquip_aaf\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences", ":id" ], "variable": [ { "key": "user_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"categories\": {\n \"nullaa\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_e\": \"\",\n \"cupidatat_11\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"proident___\": \"\",\n \"ut_9\": \"\",\n \"reprehenderit_7_\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-b4ef3b10-7bc2-4a83-a9c5-580d67a537b7" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a001a1e6-07e1-4a74-8d69-96295f8fe880" } ], "id": "644a6149-5b81-414f-a1f7-f7ff11128502", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-644a6149-5b81-414f-a1f7-f7ff11128502" }, { "name": "List user preference sets", "id": "a4aa6e01-8ee2-4343-bfa6-1078b109f733", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences" ], "variable": [ { "id": "5dd2cad7-7b20-42f7-a9f3-d308eac8de5b", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Retrieves a list of all preference sets for a specific user." }, "response": [ { "id": "389a2acf-e121-41d7-98cb-a6cff620cd8a", "name": "OK", "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/users/:user_id/preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "preferences" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"categories\": {\n \"elit_d4\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"laborum_d18\": \"\",\n \"dolor349\": \"\",\n \"ex9\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"inf2\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"categories\": {\n \"nisie\": \"\",\n \"do_80\": \"\",\n \"laborisf4\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"fugiat4\": \"\",\n \"velit09_\": \"\",\n \"proidentb93\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"magna_57\": \"\",\n \"deserunt_4\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-389a2acf-e121-41d7-98cb-a6cff620cd8a" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a4aa6e01-8ee2-4343-bfa6-1078b109f733" } ], "id": "9d439ed4-9e54-446d-a09b-722bf5b219bf", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-9d439ed4-9e54-446d-a09b-722bf5b219bf" }, { "name": "channel_data", "item": [ { "name": "{channel_id}", "item": [ { "name": "Unset channel data", "id": "db09b03b-15f6-49dc-b0d6-0b57c7260d7f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "channel_data", ":channel_id" ], "variable": [ { "id": "e099b670-3129-4b0b-b883-f09f3824b9cf", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "6e71f2ff-fb12-45a7-a3c4-3bcb4099b478", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Deletes channel data for a specific user and channel ID." }, "response": [ { "id": "debda994-c8d7-4429-b2fd-a8f8942cb17e", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "channel_data", ":channel_id" ], "variable": [ { "key": "user_id" }, { "key": "channel_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-debda994-c8d7-4429-b2fd-a8f8942cb17e" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-db09b03b-15f6-49dc-b0d6-0b57c7260d7f" }, { "name": "Get channel data", "id": "44b2863a-1c58-4105-ab79-38ff5c0d2070", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "channel_data", ":channel_id" ], "variable": [ { "id": "96f07cab-9620-47e7-8e50-161fdc7a24ff", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "5742715e-820f-4a58-999d-7dbc9413a8d5", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Retrieves the channel data for a specific user and channel ID." }, "response": [ { "id": "59a1a290-be99-4eae-9e18-581f322106cc", "name": "OK", "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/users/:user_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "channel_data", ":channel_id" ], "variable": [ { "key": "user_id" }, { "key": "channel_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channel_id\": \"\",\n \"data\": {\n \"tokens\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"token\": \"\",\n \"locale\": \"\",\n \"timezone\": \"\"\n },\n {\n \"token\": \"\",\n \"locale\": \"\",\n \"timezone\": \"\"\n }\n ]\n },\n \"__typename\": \"\",\n \"provider\": \"push_fcm\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-59a1a290-be99-4eae-9e18-581f322106cc" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-44b2863a-1c58-4105-ab79-38ff5c0d2070" }, { "name": "Set channel data", "id": "0c61f1f5-f5f8-45c1-9182-36e761191869", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "channel_data", ":channel_id" ], "variable": [ { "id": "1beae69d-e27e-4dde-a0ec-83ecaf7a3634", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." }, { "id": "4bda5e0f-cd0e-4830-9cf5-b0b236baec0c", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Updates or creates channel data for a specific user and channel ID. If no user exists in the current environment for the given `user_id`, Knock will create the user entry as part of this request." }, "response": [ { "id": "f4aef3a4-fd3d-4c9d-957a-71d8661d614c", "name": "OK", "originalRequest": { "method": "PUT", "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 \"data\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "channel_data", ":channel_id" ], "variable": [ { "key": "user_id" }, { "key": "channel_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channel_id\": \"\",\n \"data\": {\n \"tokens\": [\n \"\",\n \"\"\n ],\n \"devices\": [\n {\n \"token\": \"\",\n \"locale\": \"\",\n \"timezone\": \"\"\n },\n {\n \"token\": \"\",\n \"locale\": \"\",\n \"timezone\": \"\"\n }\n ]\n },\n \"__typename\": \"\",\n \"provider\": \"push_fcm\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-f4aef3a4-fd3d-4c9d-957a-71d8661d614c" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0c61f1f5-f5f8-45c1-9182-36e761191869" } ], "id": "a5a5f3cb-d9c0-45e9-868d-a73f69ff2dd5", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a5a5f3cb-d9c0-45e9-868d-a73f69ff2dd5" } ], "id": "8ac99bbc-b665-4c99-9e7d-06576cd2c9f7", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-8ac99bbc-b665-4c99-9e7d-06576cd2c9f7" }, { "name": "merge", "item": [ { "name": "Merge users", "id": "8949597f-7ce4-4bc1-acfb-b4012eeb6f13", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from_user_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/merge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "merge" ], "variable": [ { "id": "341edc26-0969-4da5-9b19-a7a66371a45f", "key": "user_id", "value": "", "description": "(Required) The id of the user to merge into." } ] }, "description": "Merge two users together, where the user specified with the `from_user_id` param will be merged into the user specified by `user_id`." }, "response": [ { "id": "5a8ba5b4-912a-4250-af81-77a31e12755d", "name": "OK", "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 \"from_user_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id/merge", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "merge" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-5a8ba5b4-912a-4250-af81-77a31e12755d" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-8949597f-7ce4-4bc1-acfb-b4012eeb6f13" } ], "id": "7be99719-db74-4d6d-afb8-e5265da5a87b", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-7be99719-db74-4d6d-afb8-e5265da5a87b" }, { "name": "schedules", "item": [ { "name": "List user schedules", "id": "0d1dda6f-c828-430c-a9ce-d1bb0688bb1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/schedules?workflow=&tenant=&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "schedules" ], "query": [ { "description": "The workflow key to filter schedules for.", "key": "workflow", "value": "" }, { "description": "The tenant ID to filter schedules for.", "key": "tenant", "value": "" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" } ], "variable": [ { "id": "d9e271a5-e9d7-47e6-b4af-a40f33b31968", "key": "user_id", "value": "", "description": "(Required) The user ID to list schedules for." } ] }, "description": "Returns a paginated list of schedules for a specific user, in descending order." }, "response": [ { "id": "8d4c97c6-d4f0-4386-a53a-fe1982fdb812", "name": "OK", "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/users/:user_id/schedules?workflow=&tenant=&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "schedules" ], "query": [ { "description": "The workflow key to filter schedules for.", "key": "workflow", "value": "" }, { "description": "The tenant ID to filter schedules for.", "key": "tenant", "value": "" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"id\": \"\",\n \"workflow\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"repeats\": [\n {\n \"frequency\": \"monthly\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"sat\",\n \"mon\"\n ],\n \"hours\": \"\",\n \"interval\": 1,\n \"minutes\": \"\"\n },\n {\n \"frequency\": \"weekly\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"thu\",\n \"tue\"\n ],\n \"hours\": \"\",\n \"interval\": 1,\n \"minutes\": \"\"\n }\n ],\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"__typename\": \"\",\n \"actor\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"data\": {\n \"pariatur_790\": -93107676\n },\n \"last_occurrence_at\": \"\",\n \"next_occurrence_at\": \"\",\n \"tenant\": \"\"\n },\n {\n \"id\": \"\",\n \"workflow\": \"\",\n \"recipient\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"repeats\": [\n {\n \"frequency\": \"hourly\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"tue\",\n \"tue\"\n ],\n \"hours\": \"\",\n \"interval\": 1,\n \"minutes\": \"\"\n },\n {\n \"frequency\": \"hourly\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"sun\",\n \"sat\"\n ],\n \"hours\": \"\",\n \"interval\": 1,\n \"minutes\": \"\"\n }\n ],\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"__typename\": \"\",\n \"actor\": {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n \"data\": {\n \"inaa\": -73033127.88739827\n },\n \"last_occurrence_at\": \"\",\n \"next_occurrence_at\": \"\",\n \"tenant\": \"\"\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-8d4c97c6-d4f0-4386-a53a-fe1982fdb812" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0d1dda6f-c828-430c-a9ce-d1bb0688bb1c" } ], "id": "2801b10d-6996-41e0-b883-a8bc8ed8c8d2", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-2801b10d-6996-41e0-b883-a8bc8ed8c8d2" }, { "name": "messages", "item": [ { "name": "List user messages", "id": "2d699bb9-5868-44fe-b94f-f43bf599a212", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id/messages?after=&before=&page_size=&tenant=&channel_id=&status[]=queued&status[]=bounced&engagement_status[]=archived&engagement_status[]=archived&message_ids[]=&message_ids[]=&workflow_categories[]=&workflow_categories[]=&source=&workflow_run_id=&workflow_recipient_run_id=&trigger_data=&inserted_at.gt=&inserted_at.gte=&inserted_at.lt=&inserted_at.lte=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "messages" ], "query": [ { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" }, { "description": "Limits the results to items with the corresponding tenant.", "key": "tenant", "value": "" }, { "description": "Limits the results to items with the corresponding channel ID.", "key": "channel_id", "value": "" }, { "description": "Limits the results to messages with the given delivery status.", "key": "status[]", "value": "queued" }, { "description": "Limits the results to messages with the given delivery status.", "key": "status[]", "value": "bounced" }, { "description": "Limits the results to messages with the given engagement status.", "key": "engagement_status[]", "value": "archived" }, { "description": "Limits the results to messages with the given engagement status.", "key": "engagement_status[]", "value": "archived" }, { "description": "Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.", "key": "message_ids[]", "value": "" }, { "description": "Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.", "key": "message_ids[]", "value": "" }, { "description": "Limits the results to messages related to any of the provided categories.", "key": "workflow_categories[]", "value": "" }, { "description": "Limits the results to messages related to any of the provided categories.", "key": "workflow_categories[]", "value": "" }, { "description": "Limits the results to messages triggered by the given workflow key.", "key": "source", "value": "" }, { "description": "Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.", "key": "workflow_run_id", "value": "" }, { "description": "Limits the results to messages for a specific recipient's workflow run.", "key": "workflow_recipient_run_id", "value": "" }, { "description": "Limits the results to only messages that were generated with the given data. See [trigger data filtering](/api-reference/overview/trigger-data-filtering) for more information.", "key": "trigger_data", "value": "" }, { "description": "Limits the results to items inserted after the given date.", "key": "inserted_at.gt", "value": "" }, { "description": "Limits the results to items inserted after or on the given date.", "key": "inserted_at.gte", "value": "" }, { "description": "Limits the results to items inserted before the given date.", "key": "inserted_at.lt", "value": "" }, { "description": "Limits the results to items inserted before or on the given date.", "key": "inserted_at.lte", "value": "" } ], "variable": [ { "id": "957e2bba-d513-4bd4-a042-29a4af32833d", "key": "user_id", "value": "", "description": "(Required) The user ID to list messages for." } ] }, "description": "Returns a paginated list of messages for a specific user. Messages are sorted with the most recent ones appearing first. Messages outside the account's retention window will not be included in the results." }, "response": [ { "id": "b62b86b0-3ebc-4075-9902-99331e92f34b", "name": "OK", "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/users/:user_id/messages?after=&before=&page_size=&tenant=&channel_id=&status[]=bounced&engagement_status[]=archived&message_ids[]=&workflow_categories[]=&source=&workflow_run_id=&workflow_recipient_run_id=&trigger_data=&inserted_at.gt=&inserted_at.gte=&inserted_at.lt=&inserted_at.lte=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id", "messages" ], "query": [ { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" }, { "description": "Limits the results to items with the corresponding tenant.", "key": "tenant", "value": "" }, { "description": "Limits the results to items with the corresponding channel ID.", "key": "channel_id", "value": "" }, { "description": "Limits the results to messages with the given delivery status.", "key": "status[]", "value": "bounced" }, { "description": "Limits the results to messages with the given engagement status.", "key": "engagement_status[]", "value": "archived" }, { "description": "Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.", "key": "message_ids[]", "value": "" }, { "description": "Limits the results to messages related to any of the provided categories.", "key": "workflow_categories[]", "value": "" }, { "description": "Limits the results to messages triggered by the given workflow key.", "key": "source", "value": "" }, { "description": "Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.", "key": "workflow_run_id", "value": "" }, { "description": "Limits the results to messages for a specific recipient's workflow run.", "key": "workflow_recipient_run_id", "value": "" }, { "description": "Limits the results to only messages that were generated with the given data. See [trigger data filtering](/api-reference/overview/trigger-data-filtering) for more information.", "key": "trigger_data", "value": "" }, { "description": "Limits the results to items inserted after the given date.", "key": "inserted_at.gt", "value": "" }, { "description": "Limits the results to items inserted after or on the given date.", "key": "inserted_at.gte", "value": "" }, { "description": "Limits the results to items inserted before the given date.", "key": "inserted_at.lt", "value": "" }, { "description": "Limits the results to items inserted before or on the given date.", "key": "inserted_at.lte", "value": "" } ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"channel_id\": \"\",\n \"status\": \"undelivered\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"recipient\": \"\",\n \"engagement_statuses\": [\n \"link_clicked\",\n \"read\"\n ],\n \"source\": {\n \"__typename\": \"\",\n \"key\": \"\",\n \"version_id\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"step_ref\": \"\",\n \"type\": \"broadcast\",\n \"workflow_recipient_run_id\": \"\",\n \"workflow_run_id\": \"\"\n },\n \"actors\": [\n \"\",\n \"\"\n ],\n \"archived_at\": \"\",\n \"channel\": {\n \"id\": \"\",\n \"type\": \"email\",\n \"provider\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n },\n \"clicked_at\": \"\",\n \"data\": {\n \"enim_7f1\": 31368931,\n \"irure12b\": -16228929.047431916,\n \"animab\": 59280780,\n \"irure13\": \"eu amet Excepteu\"\n },\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"metadata\": {\n \"amet49\": -36208849,\n \"irure__95\": true,\n \"officia511\": true,\n \"Excepteur_efe\": false\n },\n \"read_at\": \"\",\n \"scheduled_at\": \"\",\n \"seen_at\": \"\",\n \"tenant\": \"\",\n \"workflow\": \"\"\n },\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"channel_id\": \"\",\n \"status\": \"queued\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"recipient\": \"\",\n \"engagement_statuses\": [\n \"seen\",\n \"archived\"\n ],\n \"source\": {\n \"__typename\": \"\",\n \"key\": \"\",\n \"version_id\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"step_ref\": \"\",\n \"type\": \"guide\",\n \"workflow_recipient_run_id\": \"\",\n \"workflow_run_id\": \"\"\n },\n \"actors\": [\n \"\",\n \"\"\n ],\n \"archived_at\": \"\",\n \"channel\": {\n \"id\": \"\",\n \"type\": \"push\",\n \"provider\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n },\n \"clicked_at\": \"\",\n \"data\": {\n \"officiafd\": 97601372,\n \"incididunt_8c4\": 70962229.1799025\n },\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"metadata\": {\n \"elit_a\": false,\n \"nulla5_f\": false\n },\n \"read_at\": \"\",\n \"scheduled_at\": \"\",\n \"seen_at\": \"\",\n \"tenant\": \"\",\n \"workflow\": \"\"\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-b62b86b0-3ebc-4075-9902-99331e92f34b" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-2d699bb9-5868-44fe-b94f-f43bf599a212" } ], "id": "c22cc6e0-e3c1-456e-99a3-1d83cd640e9d", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-c22cc6e0-e3c1-456e-99a3-1d83cd640e9d" }, { "name": "Delete user", "id": "cc437f44-c52f-4344-b8c0-348a5ec2853a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "id": "63f76780-b4c9-4f2c-94fe-0f4e87f482eb", "key": "user_id", "value": "", "description": "(Required) The ID of the user to delete." } ] }, "description": "Permanently delete a user and all associated data." }, "response": [ { "id": "22039f35-edb7-442f-8c93-d2b592f40076", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-22039f35-edb7-442f-8c93-d2b592f40076" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-cc437f44-c52f-4344-b8c0-348a5ec2853a" }, { "name": "Get user", "id": "b39f0cd1-d5ea-4671-a130-a7c247db10c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "id": "6c85ff63-190f-4288-ab14-0fe0354381f4", "key": "user_id", "value": "", "description": "(Required) The ID of the user to retrieve." } ] }, "description": "Retrieve a specific user by their ID." }, "response": [ { "id": "0d139106-e422-49a0-86ce-593121885a11", "name": "OK", "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/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0d139106-e422-49a0-86ce-593121885a11" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-b39f0cd1-d5ea-4671-a130-a7c247db10c7" }, { "name": "Identify user", "id": "0c4a2594-00e5-4a99-8f99-e0c4cdff3edd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"avatar\": \"\",\n \"channel_data\": {\n \"nostrud_0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"email\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"preferences\": {\n \"consequat372\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"amet9\": \"\",\n \"id_66c\": \"\",\n \"quid4\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"consectetur_812\": \"\",\n \"cilluma0a\": \"\",\n \"nostrudea0\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"incididunta\": \"\",\n \"Duiscc6\": \"\",\n \"aliquipd\": \"\",\n \"mollit7\": \"\"\n }\n },\n \"laborum_15\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"nulla_8\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"esse04d\": \"\",\n \"dolore0\": \"\",\n \"sed8d\": \"\",\n \"ullamco_40b\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"dolore__\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "id": "55174579-4ea0-4eab-be81-c8b4b260c0c6", "key": "user_id", "value": "", "description": "(Required) The unique identifier of the user." } ] }, "description": "Create or update a user with the provided identification data. When you identify an existing user, the system merges the properties you specific with what is currently set on the user, updating only the fields included in your requests." }, "response": [ { "id": "e7cb5d92-4e4b-436c-886b-07d2ea2411f1", "name": "OK", "originalRequest": { "method": "PUT", "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 \"avatar\": \"\",\n \"channel_data\": {\n \"nostrud_0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"email\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"preferences\": {\n \"consequat372\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"amet9\": \"\",\n \"id_66c\": \"\",\n \"quid4\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"consectetur_812\": \"\",\n \"cilluma0a\": \"\",\n \"nostrudea0\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"incididunta\": \"\",\n \"Duiscc6\": \"\",\n \"aliquipd\": \"\",\n \"mollit7\": \"\"\n }\n },\n \"laborum_15\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"nulla_8\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"esse04d\": \"\",\n \"dolore0\": \"\",\n \"sed8d\": \"\",\n \"ullamco_40b\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"dolore__\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/:user_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", ":user_id" ], "variable": [ { "key": "user_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-e7cb5d92-4e4b-436c-886b-07d2ea2411f1" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0c4a2594-00e5-4a99-8f99-e0c4cdff3edd" } ], "id": "8e958c79-e5cc-4909-a741-6f4d1b5435a3", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-8e958c79-e5cc-4909-a741-6f4d1b5435a3" }, { "name": "bulk", "item": [ { "name": "preferences", "item": [ { "name": "Bulk set preferences", "id": "55c6e8e2-c158-4c8e-a6a3-6cd7b30bbf9a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"preferences\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"velit8c\": \"\",\n \"et_78f\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"aliquip_374\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"elit_0db\": \"\",\n \"tempor7\": \"\",\n \"aliqua_f73\": \"\",\n \"commodo_9\": \"\"\n }\n },\n \"user_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/bulk/preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "bulk", "preferences" ] }, "description": "Bulk sets the preferences for up to 1,000 users at a time. The preference set\u00a0`:id`\u00a0can be either\u00a0`default`\u00a0or a\u00a0`tenant.id`. Learn more about\u00a0[per-tenant preferences](/preferences/tenant-preferences). Note that this is a destructive operation and will replace any existing users' preferences with the preferences sent." }, "response": [ { "id": "b6e75bbf-8d16-4a6a-ab31-dd856e424223", "name": "OK", "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 \"preferences\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"velit8c\": \"\",\n \"et_78f\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"aliquip_374\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"elit_0db\": \"\",\n \"tempor7\": \"\",\n \"aliqua_f73\": \"\",\n \"commodo_9\": \"\"\n }\n },\n \"user_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/bulk/preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "bulk", "preferences" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"failed\",\n \"estimated_total_rows\": \"\",\n \"processed_rows\": \"\",\n \"success_count\": \"\",\n \"updated_at\": \"\",\n \"inserted_at\": \"\",\n \"completed_at\": \"\",\n \"error_count\": \"\",\n \"error_items\": [\n {\n \"id\": \"\",\n \"collection\": \"\"\n },\n {\n \"id\": \"\",\n \"collection\": \"\"\n }\n ],\n \"failed_at\": \"\",\n \"progress_path\": \"\",\n \"started_at\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-b6e75bbf-8d16-4a6a-ab31-dd856e424223" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-55c6e8e2-c158-4c8e-a6a3-6cd7b30bbf9a" } ], "id": "76bb49df-e5a7-4c20-b101-cf9eb20779cd", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-76bb49df-e5a7-4c20-b101-cf9eb20779cd" }, { "name": "identify", "item": [ { "name": "Bulk identify users", "id": "4859dcd3-b45a-4cbd-b252-84a312a1605b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"users\": [\n {\n \"id\": \"\",\n \"avatar\": \"\",\n \"channel_data\": {\n \"incididunt0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"amet_34d\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"consequat_f\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"email\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"preferences\": {\n \"autef1e\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"exercitation_c\": \"\",\n \"Ut_60d\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"commodoa61\": \"\",\n \"incididunt_b8\": \"\",\n \"ut2\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"ut_a\": \"\",\n \"cillum_6bd\": \"\"\n }\n },\n \"labore_3d7\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"eaf4b\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"labore_b\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"consectetur6\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n },\n {\n \"id\": \"\",\n \"avatar\": \"\",\n \"channel_data\": {\n \"commodo_1e5\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"sint_2\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"email\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"preferences\": {\n \"do3fd\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"commodo7c\": \"\",\n \"dolore0\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"veniam_6\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"do_43f\": \"\"\n }\n },\n \"in093\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"anim_c\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"cillumd_5\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"enim03\": \"\",\n \"qui_f\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/bulk/identify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "bulk", "identify" ] }, "description": "Identifies multiple users in a single operation. Allows creating or updating up to 1,000 users in a single batch with various properties, preferences, and channel data." }, "response": [ { "id": "f4255d18-a03e-4b12-8f36-cdd9c7cb7da7", "name": "OK", "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 \"users\": [\n {\n \"id\": \"\",\n \"avatar\": \"\",\n \"channel_data\": {\n \"incididunt0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"amet_34d\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"consequat_f\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"email\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"preferences\": {\n \"autef1e\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"exercitation_c\": \"\",\n \"Ut_60d\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"commodoa61\": \"\",\n \"incididunt_b8\": \"\",\n \"ut2\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"ut_a\": \"\",\n \"cillum_6bd\": \"\"\n }\n },\n \"labore_3d7\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"eaf4b\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"labore_b\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"consectetur6\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n },\n {\n \"id\": \"\",\n \"avatar\": \"\",\n \"channel_data\": {\n \"commodo_1e5\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"sint_2\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"email\": \"\",\n \"locale\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"preferences\": {\n \"do3fd\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"commodo7c\": \"\",\n \"dolore0\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"veniam_6\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"do_43f\": \"\"\n }\n },\n \"in093\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"anim_c\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"cillumd_5\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"enim03\": \"\",\n \"qui_f\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/bulk/identify", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "bulk", "identify" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"failed\",\n \"estimated_total_rows\": \"\",\n \"processed_rows\": \"\",\n \"success_count\": \"\",\n \"updated_at\": \"\",\n \"inserted_at\": \"\",\n \"completed_at\": \"\",\n \"error_count\": \"\",\n \"error_items\": [\n {\n \"id\": \"\",\n \"collection\": \"\"\n },\n {\n \"id\": \"\",\n \"collection\": \"\"\n }\n ],\n \"failed_at\": \"\",\n \"progress_path\": \"\",\n \"started_at\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-f4255d18-a03e-4b12-8f36-cdd9c7cb7da7" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-4859dcd3-b45a-4cbd-b252-84a312a1605b" } ], "id": "a04144c0-de12-4157-96ed-9623a9d4b69e", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a04144c0-de12-4157-96ed-9623a9d4b69e" }, { "name": "delete", "item": [ { "name": "Bulk delete users", "id": "0756fd89-5105-43dc-9c64-239b06f59000", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/bulk/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "bulk", "delete" ] }, "description": "Permanently deletes up to 1,000 users at a time." }, "response": [ { "id": "2a0c79a0-e3c6-481e-a6b4-4804fa2c10e7", "name": "OK", "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 \"user_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/users/bulk/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users", "bulk", "delete" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"failed\",\n \"estimated_total_rows\": \"\",\n \"processed_rows\": \"\",\n \"success_count\": \"\",\n \"updated_at\": \"\",\n \"inserted_at\": \"\",\n \"completed_at\": \"\",\n \"error_count\": \"\",\n \"error_items\": [\n {\n \"id\": \"\",\n \"collection\": \"\"\n },\n {\n \"id\": \"\",\n \"collection\": \"\"\n }\n ],\n \"failed_at\": \"\",\n \"progress_path\": \"\",\n \"started_at\": \"\"\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-2a0c79a0-e3c6-481e-a6b4-4804fa2c10e7" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-0756fd89-5105-43dc-9c64-239b06f59000" } ], "id": "b6fe476f-c063-4d25-99bb-37ccdadfcc00", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-b6fe476f-c063-4d25-99bb-37ccdadfcc00" } ], "id": "76bdd785-4e85-46ef-aa3e-bdc933b89007", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-76bdd785-4e85-46ef-aa3e-bdc933b89007" }, { "name": "List users", "id": "d1d8199c-808d-42f8-8cc7-28be0a7a41fd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/users?include[]=preferences&include[]=preferences&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "description": "Associated resources to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Associated resources to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" } ] }, "description": "Retrieve a paginated list of users in the environment. Defaults to 50 users per page." }, "response": [ { "id": "2421b27c-18c6-4945-b5e7-0d289a586e6d", "name": "OK", "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/users?include[]=preferences&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "users" ], "query": [ { "description": "Associated resources to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "The cursor to fetch entries after.", "key": "after", "value": "" }, { "description": "The cursor to fetch entries before.", "key": "before", "value": "" }, { "description": "The number of items per page (defaults to 50).", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n },\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"updated_at\": \"\",\n \"avatar\": \"\",\n \"created_at\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"phone_number\": \"\",\n \"timezone\": \"\"\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-2421b27c-18c6-4945-b5e7-0d289a586e6d" } ], "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-d1d8199c-808d-42f8-8cc7-28be0a7a41fd" } ], "id": "a9cafe07-0653-469a-a97e-a065df846928", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-a9cafe07-0653-469a-a97e-a065df846928" } ], "id": "ce1aee54-5bde-48f1-97be-17bb658f3f11", "createdAt": "2026-06-05T15:10:15.000Z", "updatedAt": "2026-06-05T15:10:15.000Z", "uid": "35240-ce1aee54-5bde-48f1-97be-17bb658f3f11" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.knock.app" } ] }