{ "info": { "_postman_id": "0d710700-9ed0-4f50-828a-2d8ffa6504a1", "name": "Knock Objects API", "description": "Create and manage non-user Objects in Knock and their channel data, preferences, subscriptions, and messages. Objects model accounts, projects, devices, or any non-human notification target.\n\nContact Support:\n Name: Knock", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:10:29.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "lastUpdatedBy": "35240", "uid": "35240-0d710700-9ed0-4f50-828a-2d8ffa6504a1" }, "item": [ { "name": "v1", "item": [ { "name": "objects", "item": [ { "name": "{collection}", "item": [ { "name": "{object_id}", "item": [ { "name": "preferences", "item": [ { "name": "{id}", "item": [ { "name": "workflows", "item": [ { "name": "{key}", "item": [ { "name": "Update a workflow preference", "id": "6f44f458-4024-438e-9862-32ad51f7c148", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id/workflows/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "workflows", ":key" ], "variable": [ { "id": "1e7732d5-8686-4987-b12c-140332ce92b7", "key": "collection" }, { "id": "adb5b157-8b65-4f73-bac8-eac0a4d6e196", "key": "object_id" }, { "id": "82dd7156-b4c6-4293-a83e-f363d7bd2685", "key": "id" }, { "id": "f4f32931-2340-4d05-ab50-9bc435ea7ce4", "key": "key" } ] }, "description": "Updates a specific workflow preference for an object's preference set." }, "response": [ { "id": "3e90bc53-b872-4606-8a22-d21a768a29de", "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/objects/:collection/:object_id/preferences/:id/workflows/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "workflows", ":key" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-3e90bc53-b872-4606-8a22-d21a768a29de" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-6f44f458-4024-438e-9862-32ad51f7c148" } ], "id": "3863de3f-c114-4735-9a26-db0132f48459", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-3863de3f-c114-4735-9a26-db0132f48459" }, { "name": "Update workflows in preference set", "id": "f16358ba-6ed0-4197-9b50-a5c64b619365", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id/workflows", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "workflows" ], "variable": [ { "id": "d8e4c781-3ca9-4a5d-96be-ee3cc0113be5", "key": "collection" }, { "id": "6341105c-d135-4f58-8cfa-b729577c67bd", "key": "object_id" }, { "id": "c24a38bf-61a9-4a0f-9908-f576a007907f", "key": "id" } ] }, "description": "Updates the workflow preferences for an object's preference set." }, "response": [ { "id": "0aadf597-2003-4f3c-adb9-071a5e3b3d8c", "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/objects/:collection/:object_id/preferences/:id/workflows", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "workflows" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-0aadf597-2003-4f3c-adb9-071a5e3b3d8c" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-f16358ba-6ed0-4197-9b50-a5c64b619365" } ], "id": "4cf4d973-b874-4b7e-9cbb-12a1b96282ff", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-4cf4d973-b874-4b7e-9cbb-12a1b96282ff" }, { "name": "channel_types", "item": [ { "name": "{type}", "item": [ { "name": "Update a channel type preference", "id": "735b5226-23d6-426c-9e43-fed479ff54a7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id/channel_types/:type", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "channel_types", ":type" ], "variable": [ { "id": "f70cb782-1ffe-4c5d-b7fa-5946dba671dc", "key": "collection" }, { "id": "df0cb484-9868-4d7e-a90f-37becfa4ff5a", "key": "object_id" }, { "id": "f89dffcb-d5c4-4c97-9af2-563b743cba1d", "key": "id" }, { "id": "811d86e2-6988-4a2f-a782-c07170c028be", "key": "type" } ] }, "description": "Updates a specific channel type preference for an object's preference set." }, "response": [ { "id": "e4ce1d7c-1581-4d8c-b722-19ed20d91e6d", "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/objects/:collection/:object_id/preferences/:id/channel_types/:type", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "channel_types", ":type" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-e4ce1d7c-1581-4d8c-b722-19ed20d91e6d" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-735b5226-23d6-426c-9e43-fed479ff54a7" } ], "id": "36300cb6-d99f-4b8a-8497-e69bf8c1b358", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-36300cb6-d99f-4b8a-8497-e69bf8c1b358" }, { "name": "Update channel types in preference set", "id": "d4fb1004-f536-4ab6-91bb-f2f14dc73eea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id/channel_types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "channel_types" ], "variable": [ { "id": "2f767aab-a3a4-4362-85cd-7cfc242f8338", "key": "collection" }, { "id": "49a68d27-4882-4a5e-b8d9-1694a25e114d", "key": "object_id" }, { "id": "893ca3f3-2504-4bbf-9ae5-b7d44f7677cf", "key": "id" } ] }, "description": "Updates the channel type preferences for an object's preference set." }, "response": [ { "id": "634c8ee1-f2a4-4f17-9744-ceea7788e7c8", "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/objects/:collection/:object_id/preferences/:id/channel_types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "channel_types" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-634c8ee1-f2a4-4f17-9744-ceea7788e7c8" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-d4fb1004-f536-4ab6-91bb-f2f14dc73eea" } ], "id": "0dc8bbe7-94d2-4ea1-83db-4dd31cf2686e", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-0dc8bbe7-94d2-4ea1-83db-4dd31cf2686e" }, { "name": "categories", "item": [ { "name": "{key}", "item": [ { "name": "Update a category preference", "id": "e41b8cd7-9be5-4fc4-89db-9776e858b3c7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id/categories/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "categories", ":key" ], "variable": [ { "id": "bb0ded1e-8f36-458f-bd85-88e606caec48", "key": "collection" }, { "id": "0f5b19ba-4347-4ead-9e32-17d41abe5e06", "key": "object_id" }, { "id": "ea2d93d0-7d6c-44d2-b383-9bf37da42078", "key": "id" }, { "id": "d79f7622-8271-4586-a45f-645cbc843e52", "key": "key" } ] }, "description": "Updates a specific category preference for an object's preference set. Deprecated." }, "response": [ { "id": "90a13608-1027-496b-bbf7-b81eae5fc4c0", "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/objects/:collection/:object_id/preferences/:id/categories/:key", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "categories", ":key" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-90a13608-1027-496b-bbf7-b81eae5fc4c0" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-e41b8cd7-9be5-4fc4-89db-9776e858b3c7" } ], "id": "4ef001d9-458c-499e-8d78-3a2302b9f37a", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-4ef001d9-458c-499e-8d78-3a2302b9f37a" }, { "name": "Update categories in preference set", "id": "adc3867a-f550-431e-817e-0bb1b7b36ac6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "categories" ], "variable": [ { "id": "81d558db-cc3b-46df-91f1-5e03f2739633", "key": "collection" }, { "id": "6076bbea-5de3-469b-a2d8-f33479b18521", "key": "object_id" }, { "id": "66084f3d-8073-4c8d-872a-6d6065c3a8de", "key": "id" } ] }, "description": "Updates the category preferences for an object's preference set." }, "response": [ { "id": "56eefc8d-42a3-4807-a7e9-2f12dd00188c", "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/objects/:collection/:object_id/preferences/:id/categories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id", "categories" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-56eefc8d-42a3-4807-a7e9-2f12dd00188c" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-adc3867a-f550-431e-817e-0bb1b7b36ac6" } ], "id": "4f055e58-e16d-4333-bebd-b08b89092ee9", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-4f055e58-e16d-4333-bebd-b08b89092ee9" }, { "name": "Delete object preference set", "id": "1da53922-af9c-446c-bbd8-ac3a56e9d40f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id" ], "variable": [ { "id": "d1222c83-30ea-43c3-a884-ff54580d79c8", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "1dbe79cf-3c41-4973-8cfa-584f5f045553", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." }, { "id": "1e3d07dc-d4a8-4433-a32b-5e1c9e9dbf93", "key": "id", "value": "default", "description": "(Required) Unique identifier for the preference set." } ] }, "description": "Unsets the preference set for the object, removing it entirely." }, "response": [ { "id": "6a11faf2-412a-4162-a0d3-d179c25585db", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id" ], "variable": [ { "key": "collection" }, { "key": "object_id" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-6a11faf2-412a-4162-a0d3-d179c25585db" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-1da53922-af9c-446c-bbd8-ac3a56e9d40f" }, { "name": "Get object preference set", "id": "88b83da5-3dd5-4e0e-a449-7a353d629aed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id" ], "variable": [ { "id": "14013b1e-fdda-4849-9f9e-3145058e85b8", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "eec04c6b-1631-483d-a1a7-3dff6245b91c", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." }, { "id": "b34d0269-ce51-4422-baca-c06d651aab8e", "key": "id", "value": "default", "description": "(Required) Unique identifier for the preference set." } ] }, "description": "Returns the preference set for the specified object and preference set `id`." }, "response": [ { "id": "46b96d8d-2ad2-4a1c-9801-7ba707ef86f0", "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/objects/:collection/:object_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-46b96d8d-2ad2-4a1c-9801-7ba707ef86f0" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-88b83da5-3dd5-4e0e-a449-7a353d629aed" }, { "name": "Update a preference set", "id": "8a385897-df48-462b-a8b2-960b40f0f3cb", "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 \"deserunt_9\": \"\",\n \"velit_8b\": \"\",\n \"ullamco_f2c\": \"\",\n \"eiusmod_\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"qui_7d_\": \"\",\n \"officiab3\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"est5\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id" ], "variable": [ { "id": "303c1703-2285-4f23-982c-142997b41e6c", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "3188bcf8-fc9b-4ab5-81a0-bd6db3a13b50", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." }, { "id": "f5276e3c-28f6-4704-8007-bcc93da6f371", "key": "id", "value": "default", "description": "(Required) Unique identifier for the preference set." } ] }, "description": "Sets preferences within the given preference set. 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. If no object exists in the current environment for the given `:collection` and `:object_id`, Knock will create the object as part of this request. The preference set `:id` can be either `default` or a `tenant.id`. Learn more about [per-tenant preferences](/preferences/tenant-preferences)." }, "response": [ { "id": "9b844daa-577d-4f14-81bd-f4caaae6ae83", "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 \"deserunt_9\": \"\",\n \"velit_8b\": \"\",\n \"ullamco_f2c\": \"\",\n \"eiusmod_\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"qui_7d_\": \"\",\n \"officiab3\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"est5\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences", ":id" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"officia63a\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"enim2\": \"\",\n \"sunt7\": \"\",\n \"dolor_5a\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"nisidd1\": \"\",\n \"officia_12\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-9b844daa-577d-4f14-81bd-f4caaae6ae83" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-8a385897-df48-462b-a8b2-960b40f0f3cb" } ], "id": "0ff32e38-b339-4c92-921c-17b1f01bccbb", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-0ff32e38-b339-4c92-921c-17b1f01bccbb" }, { "name": "List preference sets", "id": "eb27618a-92dc-4b00-a570-efebbd120e4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences" ], "variable": [ { "id": "6f4b1330-2280-4500-83ab-88e56428a143", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "19f79544-bd4a-4a0a-bc39-da41134e5335", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Returns a paginated list of preference sets for the specified object." }, "response": [ { "id": "cfb04fc3-ffeb-4b66-963a-f85339d722d6", "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/objects/:collection/:object_id/preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "preferences" ], "variable": [ { "key": "collection" }, { "key": "object_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 \"laboris_02\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"proident__\": \"\",\n \"sit_c6e\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"Duisb\": \"\",\n \"suntd\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"categories\": {\n \"minim8f\": \"\",\n \"aliqua_13\": \"\",\n \"fugiat09\": \"\",\n \"minim_8_\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"occaecatf2b\": \"\",\n \"aliquip_e9\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"enimb\": \"\",\n \"cillum__\": \"\",\n \"Lorem_c\": \"\"\n }\n }\n]", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-cfb04fc3-ffeb-4b66-963a-f85339d722d6" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-eb27618a-92dc-4b00-a570-efebbd120e4a" } ], "id": "5e2112d3-51b7-40d8-85dd-2c3fb10b4f89", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-5e2112d3-51b7-40d8-85dd-2c3fb10b4f89" }, { "name": "channel_data", "item": [ { "name": "{channel_id}", "item": [ { "name": "Unset channel data", "id": "f2c7c041-7072-4c4c-bc80-baf166e0322a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "channel_data", ":channel_id" ], "variable": [ { "id": "2744db7e-ef50-403c-bf1a-f9defe5901a7", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "12473dea-c6da-4fc3-ac06-38b9e4488ad1", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." }, { "id": "248b3ce3-4554-4cef-b357-88537d07d4cb", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Unsets the channel data for the specified object and channel." }, "response": [ { "id": "f0eec6e4-28d4-45d0-b0c0-12f25bbaed1c", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "channel_data", ":channel_id" ], "variable": [ { "key": "collection" }, { "key": "object_id" }, { "key": "channel_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-f0eec6e4-28d4-45d0-b0c0-12f25bbaed1c" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-f2c7c041-7072-4c4c-bc80-baf166e0322a" }, { "name": "Get channel data", "id": "89753d69-68a4-45a0-bd51-b1232d09abba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "channel_data", ":channel_id" ], "variable": [ { "id": "0b384876-c840-4642-a1c4-8a9aa0586ff5", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "0d2ca573-e1df-4990-a6f9-507d32dbfe00", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." }, { "id": "1fe6e7c7-8632-4592-9dfa-4cff1161f006", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Returns the channel data for the specified object and channel." }, "response": [ { "id": "8ad0aaab-ba18-4eda-aa14-accd5b0f9757", "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/objects/:collection/:object_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "channel_data", ":channel_id" ], "variable": [ { "key": "collection" }, { "key": "object_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_expo\"\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-8ad0aaab-ba18-4eda-aa14-accd5b0f9757" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-89753d69-68a4-45a0-bd51-b1232d09abba" }, { "name": "Set channel data", "id": "a0a6a206-a75f-47e4-a737-de3ea87fa1d8", "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/objects/:collection/:object_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "channel_data", ":channel_id" ], "variable": [ { "id": "ac4b3de0-7011-458b-9d3e-20049d7a11a2", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "83c1a4c2-2a6c-451d-8873-a9fca348712a", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." }, { "id": "18346b23-9e62-4730-b6fe-1ced69852f53", "key": "channel_id", "value": "", "description": "(Required) The unique identifier for the channel." } ] }, "description": "Sets the channel data for the specified object and channel. If no object exists in the current environment for the given `collection` and `object_id`, Knock will create the object as part of this request." }, "response": [ { "id": "61b2a09c-8c81-424b-8032-f3c7ca6376fa", "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/objects/:collection/:object_id/channel_data/:channel_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "channel_data", ":channel_id" ], "variable": [ { "key": "collection" }, { "key": "object_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_expo\"\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-61b2a09c-8c81-424b-8032-f3c7ca6376fa" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-a0a6a206-a75f-47e4-a737-de3ea87fa1d8" } ], "id": "4ce0c807-12a6-449c-ba2c-5bd710c60f85", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-4ce0c807-12a6-449c-ba2c-5bd710c60f85" } ], "id": "8869fad8-1ced-4ced-81fd-770ae3e8b61b", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-8869fad8-1ced-4ced-81fd-770ae3e8b61b" }, { "name": "subscriptions", "item": [ { "name": "Delete subscriptions", "id": "a72aa57c-7dbb-4e11-ac6c-b522e3c812cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "subscriptions" ], "variable": [ { "id": "85ad5e6a-0a73-45c9-abd9-5ff3a7ab4c66", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "67a87064-eed7-4473-80e9-3eb20231a705", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Delete subscriptions for the specified recipients from an object. Returns the list of deleted subscriptions." }, "response": [ { "id": "492be47f-bb13-4fab-9a5a-dcb0b14c39dc", "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 \"recipients\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "subscriptions" ], "variable": [ { "key": "collection" }, { "key": "object_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\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 \"sed_0\": -91105866,\n \"proident_f0_\": \"anim aute occaecat in\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"occaecat_d3\": \"id ea\"\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 \"dolor_8ed\": \"inci\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"Excepteur_cc\": 90800389,\n \"sunt4\": -6277724.391944826,\n \"deserunt_fcd\": 72276324\n }\n }\n]", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-492be47f-bb13-4fab-9a5a-dcb0b14c39dc" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-a72aa57c-7dbb-4e11-ac6c-b522e3c812cf" }, { "name": "List subscriptions", "id": "4c550cc0-888a-41da-bde4-3fd0e3c79fd1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/subscriptions?mode=object&include[]=preferences&include[]=preferences&recipients[]=&recipients[]=&objects[]=[object Object]&objects[]=[object Object]&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "subscriptions" ], "query": [ { "description": "Mode of the request. `recipient` to list the objects that the provided object is subscribed to, `object` to list the recipients that subscribe to the provided object.", "key": "mode", "value": "object" }, { "description": "Additional fields to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Additional fields to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Recipients to filter by (only used if mode is `object`).", "key": "recipients[]", "value": "" }, { "description": "Recipients to filter by (only used if mode is `object`).", "key": "recipients[]", "value": "" }, { "description": "Objects to filter by (only used if mode is `recipient`).", "key": "objects[]", "value": "[object Object]" }, { "description": "Objects to filter by (only used if mode is `recipient`).", "key": "objects[]", "value": "[object Object]" }, { "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": "bd4c3953-2218-40a1-a9dd-5f29d9834647", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "4bb9c3a5-52aa-43cc-9882-6b4516a12d95", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "List subscriptions for an object. Either list the recipients that subscribe to the provided object, or list the objects that the provided object is subscribed to. Determined by the `mode` query parameter." }, "response": [ { "id": "28dab15f-a141-46f4-9bb0-b528479145b4", "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/objects/:collection/:object_id/subscriptions?mode=object&include[]=preferences&recipients[]=&objects[]=[object Object]&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "subscriptions" ], "query": [ { "description": "Mode of the request. `recipient` to list the objects that the provided object is subscribed to, `object` to list the recipients that subscribe to the provided object.", "key": "mode", "value": "object" }, { "description": "Additional fields to include in the response.", "key": "include[]", "value": "preferences" }, { "description": "Recipients to filter by (only used if mode is `object`).", "key": "recipients[]", "value": "" }, { "description": "Objects to filter by (only used if mode is `recipient`).", "key": "objects[]", "value": "[object Object]" }, { "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": "collection" }, { "key": "object_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 \"consectetur_8\": \"voluptate\",\n \"aliquip9e3\": \"et consectetur culpa dolore consequat\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"amet28\": true,\n \"magna_9b0\": 68204542\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 \"sed_8d5\": 1329699.7508368343,\n \"do_233\": \"labore velit incididunt\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"sed_0e1\": false,\n \"cupidatat5\": false,\n \"ipsum_4\": true,\n \"incididunt759\": false\n }\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-28dab15f-a141-46f4-9bb0-b528479145b4" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-4c550cc0-888a-41da-bde4-3fd0e3c79fd1" }, { "name": "Add subscriptions", "id": "28bb31cb-2b6f-4ad8-8107-162511cb8f6c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"esse_2c4\": \"adipisicing ea qui\",\n \"aliquip92\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "subscriptions" ], "variable": [ { "id": "8b15dd26-fc66-486e-8bff-3b3d900abb5f", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "016746b9-18ad-440e-bbf3-32ff1707d555", "key": "object_id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Add subscriptions for an object. If a subscription already exists, it will be updated. This endpoint also handles [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients) for the `recipient`." }, "response": [ { "id": "da6b030e-34da-474a-8c2d-f17118ac34f1", "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 \"recipients\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"esse_2c4\": \"adipisicing ea qui\",\n \"aliquip92\": false\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:object_id/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":object_id", "subscriptions" ], "variable": [ { "key": "collection" }, { "key": "object_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\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 \"sed_0\": -91105866,\n \"proident_f0_\": \"anim aute occaecat in\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"occaecat_d3\": \"id ea\"\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 \"dolor_8ed\": \"inci\"\n }\n },\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"properties\": {\n \"Excepteur_cc\": 90800389,\n \"sunt4\": -6277724.391944826,\n \"deserunt_fcd\": 72276324\n }\n }\n]", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-da6b030e-34da-474a-8c2d-f17118ac34f1" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-28bb31cb-2b6f-4ad8-8107-162511cb8f6c" } ], "id": "5e5bad5a-7c50-4842-aec6-bf0b15883d8a", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-5e5bad5a-7c50-4842-aec6-bf0b15883d8a" } ], "id": "6044ed2c-d9a1-4057-83d6-491e1b41d72c", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-6044ed2c-d9a1-4057-83d6-491e1b41d72c" }, { "name": "bulk", "item": [ { "name": "delete", "item": [ { "name": "Bulk delete objects", "id": "9bee381e-3474-4ffa-8148-09d274695cf3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"object_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "delete" ], "variable": [ { "id": "3109a979-59d4-4e80-bd23-d94ffba61da8", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." } ] }, "description": "Bulk deletes objects from the specified collection." }, "response": [ { "id": "fd3b117f-3b98-41e8-a536-ee1bc5c1a57d", "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 \"object_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "delete" ], "variable": [ { "key": "collection" } ] } }, "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:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-fd3b117f-3b98-41e8-a536-ee1bc5c1a57d" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-9bee381e-3474-4ffa-8148-09d274695cf3" } ], "id": "cf388db0-17fe-49b8-8e5d-066593fdde28", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-cf388db0-17fe-49b8-8e5d-066593fdde28" }, { "name": "subscriptions", "item": [ { "name": "add", "item": [ { "name": "Bulk add subscriptions", "id": "0116b56a-85e8-479d-a90e-7bf96d17e00f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"essef\": \"eiusmod\",\n \"ex4d\": true,\n \"ipsumf3\": \"consectetur esse dolore\"\n }\n },\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"ullamcoa\": \"incididunt fugiat occaecat consequat\",\n \"cupidatatb0\": -3924759,\n \"quisdd\": true,\n \"deserunt19\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/subscriptions/add", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "subscriptions", "add" ], "variable": [ { "id": "b05edeed-952e-47ec-bb90-e011d857aeef", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." } ] }, "description": "Add subscriptions for all objects in a single collection. If a subscription for an object in the collection already exists, it will be updated. This endpoint also handles [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients) for the `recipient` field." }, "response": [ { "id": "1962a130-55f8-4af3-8973-609cd6df7802", "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 \"subscriptions\": [\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"essef\": \"eiusmod\",\n \"ex4d\": true,\n \"ipsumf3\": \"consectetur esse dolore\"\n }\n },\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"ullamcoa\": \"incididunt fugiat occaecat consequat\",\n \"cupidatatb0\": -3924759,\n \"quisdd\": true,\n \"deserunt19\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/subscriptions/add", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "subscriptions", "add" ], "variable": [ { "key": "collection" } ] } }, "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:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-1962a130-55f8-4af3-8973-609cd6df7802" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-0116b56a-85e8-479d-a90e-7bf96d17e00f" } ], "id": "3fcf2792-6d1b-4d83-a66e-9885009bf682", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-3fcf2792-6d1b-4d83-a66e-9885009bf682" }, { "name": "delete", "item": [ { "name": "Bulk delete subscriptions", "id": "94169d63-4813-4fb3-8417-27de836ce0fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"subscriptions\": [\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/subscriptions/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "subscriptions", "delete" ], "variable": [ { "id": "da8ad244-022f-4c32-b4bb-9e7ef3efd8bd", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." } ] }, "description": "Delete subscriptions for many objects in a single collection type. If a subscription for an object in the collection doesn't exist, it will be skipped." }, "response": [ { "id": "b96cff09-8990-4000-bf1f-03037581d126", "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 \"subscriptions\": [\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"recipients\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/subscriptions/delete", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "subscriptions", "delete" ], "variable": [ { "key": "collection" } ] } }, "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:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-b96cff09-8990-4000-bf1f-03037581d126" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-94169d63-4813-4fb3-8417-27de836ce0fe" } ], "id": "947d10ec-00d0-4d5f-a544-00d453d28fff", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-947d10ec-00d0-4d5f-a544-00d453d28fff" } ], "id": "55f55b63-4417-4914-8402-abfbce27ea23", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-55f55b63-4417-4914-8402-abfbce27ea23" }, { "name": "set", "item": [ { "name": "Bulk set objects", "id": "cf10bf1f-16c4-46ce-96ea-8160b4579e86", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"objects\": [\n {\n \"id\": \"\",\n \"channel_data\": {\n \"laboref69\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"labore9\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"deserunt_2b0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"name\": \"\",\n \"preferences\": {\n \"aliquip67\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"dolored7\": \"\",\n \"amet_8d2\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"exercitation_a_\": \"\",\n \"adipisicing_dda\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"velit_bf8\": \"\",\n \"ullamcob9a\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"channel_data\": {\n \"dolore_a24\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"name\": \"\",\n \"preferences\": {\n \"proidente\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"enim__5e\": \"\",\n \"amet_f5\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_b4\": \"\",\n \"tempor78\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"id9f\": \"\"\n }\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/set", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "set" ], "variable": [ { "id": "9ce13631-1ce5-4d60-8612-6211d6203eaf", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." } ] }, "description": "Bulk sets up to 1,000 objects at a time in the specified collection." }, "response": [ { "id": "db153b4c-e49b-4b30-90dd-5f027899f1e4", "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 \"objects\": [\n {\n \"id\": \"\",\n \"channel_data\": {\n \"laboref69\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"labore9\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n },\n \"deserunt_2b0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"name\": \"\",\n \"preferences\": {\n \"aliquip67\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"dolored7\": \"\",\n \"amet_8d2\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"exercitation_a_\": \"\",\n \"adipisicing_dda\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"velit_bf8\": \"\",\n \"ullamcob9a\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"channel_data\": {\n \"dolore_a24\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"created_at\": \"\",\n \"name\": \"\",\n \"preferences\": {\n \"proidente\": {\n \"__persistence_strategy__\": \"replace\",\n \"categories\": {\n \"enim__5e\": \"\",\n \"amet_f5\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"ut_b4\": \"\",\n \"tempor78\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"id9f\": \"\"\n }\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/bulk/set", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", "bulk", "set" ], "variable": [ { "key": "collection" } ] } }, "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:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-db153b4c-e49b-4b30-90dd-5f027899f1e4" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-cf10bf1f-16c4-46ce-96ea-8160b4579e86" } ], "id": "b0132698-c646-43f0-8970-d39140bfb700", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-b0132698-c646-43f0-8970-d39140bfb700" } ], "id": "2500c7e2-dcfd-4b53-a3b6-94d4933ef41c", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-2500c7e2-dcfd-4b53-a3b6-94d4933ef41c" }, { "name": "{id}", "item": [ { "name": "schedules", "item": [ { "name": "List object schedules", "id": "ecd3d757-e436-49c8-bccc-2c0508e7dba5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id/schedules?tenant=&workflow=&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id", "schedules" ], "query": [ { "description": "Filter schedules by tenant id.", "key": "tenant", "value": "" }, { "description": "Filter schedules by workflow id.", "key": "workflow", "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": "9980735c-4ebb-4817-8279-61af674d38ff", "key": "collection", "value": "", "description": "(Required) The collection of the object to list schedules for." }, { "id": "02b5f846-72bb-4910-b701-6c99944f326f", "key": "id", "value": "", "description": "(Required) The ID of the object to list schedules for." } ] }, "description": "Returns a paginated list of schedules for an object." }, "response": [ { "id": "ddbf9bd4-215c-4184-90e9-93098c8e4247", "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/objects/:collection/:id/schedules?tenant=&workflow=&after=&before=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id", "schedules" ], "query": [ { "description": "Filter schedules by tenant id.", "key": "tenant", "value": "" }, { "description": "Filter schedules by workflow id.", "key": "workflow", "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": "collection" }, { "key": "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 \"tue\",\n \"tue\"\n ],\n \"hours\": \"\",\n \"interval\": 1,\n \"minutes\": \"\"\n },\n {\n \"frequency\": \"daily\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"wed\",\n \"thu\"\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 \"magnab\": -18120206\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\": \"weekly\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"sat\",\n \"thu\"\n ],\n \"hours\": \"\",\n \"interval\": 1,\n \"minutes\": \"\"\n },\n {\n \"frequency\": \"daily\",\n \"__typename\": \"\",\n \"day_of_month\": \"\",\n \"days\": [\n \"wed\",\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 \"reprehenderit0b\": -78158173,\n \"dolore60\": -8635318.37218745,\n \"fugiat1\": \"tempor veniam\"\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:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-ddbf9bd4-215c-4184-90e9-93098c8e4247" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-ecd3d757-e436-49c8-bccc-2c0508e7dba5" } ], "id": "f6cceaf8-cc09-4b27-8b14-b3fa588bed05", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-f6cceaf8-cc09-4b27-8b14-b3fa588bed05" }, { "name": "messages", "item": [ { "name": "List messages", "id": "0cbe97da-ae85-4ece-a3e9-315d674f2c99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id/messages?after=&before=&page_size=&tenant=&channel_id=&status[]=undelivered&status[]=delivered&engagement_status[]=unseen&engagement_status[]=read&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", "objects", ":collection", ":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": "undelivered" }, { "description": "Limits the results to messages with the given delivery status.", "key": "status[]", "value": "delivered" }, { "description": "Limits the results to messages with the given engagement status.", "key": "engagement_status[]", "value": "unseen" }, { "description": "Limits the results to messages with the given engagement status.", "key": "engagement_status[]", "value": "read" }, { "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": "a5df60a4-717c-463f-a7db-200b83610436", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "b3b7e017-28cd-4d88-b1e5-a8c06ec76b46", "key": "id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Returns a paginated list of messages for a specific object in the given collection. Allows filtering by message status and provides various sorting options." }, "response": [ { "id": "004216ce-6116-4066-8819-3a29b31f2664", "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/objects/:collection/:id/messages?after=&before=&page_size=&tenant=&channel_id=&status[]=delivered&engagement_status[]=read&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", "objects", ":collection", ":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": "delivered" }, { "description": "Limits the results to messages with the given engagement status.", "key": "engagement_status[]", "value": "read" }, { "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": "collection" }, { "key": "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\": \"delivered\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"recipient\": \"\",\n \"engagement_statuses\": [\n \"read\",\n \"interacted\"\n ],\n \"source\": {\n \"__typename\": \"\",\n \"key\": \"\",\n \"version_id\": \"\",\n \"categories\": [\n \"\",\n \"\"\n ],\n \"step_ref\": \"\",\n \"type\": \"workflow\",\n \"workflow_recipient_run_id\": \"\",\n \"workflow_run_id\": \"\"\n },\n \"actors\": [\n \"\",\n \"\"\n ],\n \"archived_at\": \"\",\n \"channel\": {\n \"id\": \"\",\n \"type\": \"in_app_guide\",\n \"provider\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n },\n \"clicked_at\": \"\",\n \"data\": {\n \"consequatca\": -93660487.84037799,\n \"deserunt_efe\": -62706510\n },\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"metadata\": {\n \"do_c99\": 86899308.0159123\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\": \"bounced\",\n \"inserted_at\": \"\",\n \"updated_at\": \"\",\n \"recipient\": \"\",\n \"engagement_statuses\": [\n \"link_clicked\",\n \"interacted\"\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\": \"in_app_guide\",\n \"provider\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"key\": \"\",\n \"name\": \"\"\n },\n \"clicked_at\": \"\",\n \"data\": {\n \"et7\": true,\n \"nostrud7\": -8032935\n },\n \"interacted_at\": \"\",\n \"link_clicked_at\": \"\",\n \"metadata\": {\n \"cupidatatf\": -38473115,\n \"Ut_338\": true\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:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-004216ce-6116-4066-8819-3a29b31f2664" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-0cbe97da-ae85-4ece-a3e9-315d674f2c99" } ], "id": "65d2bd96-440f-43a7-b08b-13d4d53a2428", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-65d2bd96-440f-43a7-b08b-13d4d53a2428" }, { "name": "Delete an object", "id": "b7d8617c-c216-4e00-a60b-4b6b84cb15d0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id" ], "variable": [ { "id": "e75be410-5072-4e85-b549-80566f088252", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "e38784f7-fa03-4605-adbf-f6fdcebe9be1", "key": "id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Permanently removes an object from the specified collection. This operation cannot be undone." }, "response": [ { "id": "009f9930-40d6-49aa-8474-325d8c269d13", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id" ], "variable": [ { "key": "collection" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-009f9930-40d6-49aa-8474-325d8c269d13" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-b7d8617c-c216-4e00-a60b-4b6b84cb15d0" }, { "name": "Get an object", "id": "91ee2351-2a93-42f7-a883-4d6662469783", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id" ], "variable": [ { "id": "138b355a-8f55-42e0-87a3-59c1707fb751", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "79d5182c-a36e-4f98-a452-a05247a696b0", "key": "id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Retrieves a specific object by its ID from the specified collection. Returns the object with all its properties." }, "response": [ { "id": "a81329cd-cbfe-4802-a820-14eabb2442ae", "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/objects/:collection/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id" ], "variable": [ { "key": "collection" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"collection\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"properties\": {\n \"ullamco_24\": \"aute proident\",\n \"quis_be\": 1138916.304808423\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-a81329cd-cbfe-4802-a820-14eabb2442ae" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-91ee2351-2a93-42f7-a883-4d6662469783" }, { "name": "Set an object", "id": "90e1981a-35a3-433c-aec2-edf34d68d5f6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_data\": {\n \"labore_0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"locale\": \"\",\n \"name\": \"\",\n \"preferences\": {\n \"dolor3\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"magna_99\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"incididunt_e4\": \"\",\n \"Loremf8\": \"\",\n \"sit__a9\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"doa\": \"\",\n \"occaecat40\": \"\",\n \"dolore9\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id" ], "variable": [ { "id": "920e4f54-d64b-4882-873d-8ab1abc4f7a4", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." }, { "id": "2643dbb3-92c8-44af-9d4a-5b999a964dc9", "key": "id", "value": "", "description": "(Required) Unique identifier for the object." } ] }, "description": "Creates a new object or updates an existing one in the specified collection. This operation is used to identify objects with their properties, as well as optional preferences and channel data." }, "response": [ { "id": "efea9539-f4d9-48cd-b162-5badfe335da4", "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_data\": {\n \"labore_0\": {\n \"tokens\": [\n \"\",\n \"\"\n ]\n }\n },\n \"locale\": \"\",\n \"name\": \"\",\n \"preferences\": {\n \"dolor3\": {\n \"__persistence_strategy__\": \"merge\",\n \"categories\": {\n \"magna_99\": \"\"\n },\n \"channel_types\": {\n \"chat\": \"\",\n \"email\": \"\",\n \"http\": \"\",\n \"in_app_feed\": \"\",\n \"push\": \"\",\n \"sms\": \"\"\n },\n \"channels\": {\n \"incididunt_e4\": \"\",\n \"Loremf8\": \"\",\n \"sit__a9\": \"\"\n },\n \"commercial_subscribed\": \"\",\n \"workflows\": {\n \"doa\": \"\",\n \"occaecat40\": \"\",\n \"dolore9\": \"\"\n }\n }\n },\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/objects/:collection/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection", ":id" ], "variable": [ { "key": "collection" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"__typename\": \"\",\n \"id\": \"\",\n \"collection\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"properties\": {\n \"ullamco_24\": \"aute proident\",\n \"quis_be\": 1138916.304808423\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-efea9539-f4d9-48cd-b162-5badfe335da4" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-90e1981a-35a3-433c-aec2-edf34d68d5f6" } ], "id": "8e09fec5-8f50-4bab-923f-d70540fe2452", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-8e09fec5-8f50-4bab-923f-d70540fe2452" }, { "name": "List objects in a collection", "id": "e3345e18-9af0-4ee1-8618-35c256da5e99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/objects/:collection?after=&before=&page_size=&include[]=preferences&include[]=preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection" ], "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": "Includes preferences of the objects in the response.", "key": "include[]", "value": "preferences" }, { "description": "Includes preferences of the objects in the response.", "key": "include[]", "value": "preferences" } ], "variable": [ { "id": "1d81f192-e9ce-4440-af4a-3e65a4fbca2a", "key": "collection", "value": "", "description": "(Required) The collection this object belongs to." } ] }, "description": "Returns a paginated list of objects from the specified collection. Optionally includes preference data for the objects." }, "response": [ { "id": "e0cdab46-11a5-48e3-afe6-bf6fd144dcdc", "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/objects/:collection?after=&before=&page_size=&include[]=preferences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "objects", ":collection" ], "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": "Includes preferences of the objects in the response.", "key": "include[]", "value": "preferences" } ], "variable": [ { "key": "collection" } ] } }, "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 \"collection\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"properties\": {\n \"qui4\": \"nulla in\"\n }\n },\n {\n \"__typename\": \"\",\n \"id\": \"\",\n \"collection\": \"\",\n \"updated_at\": \"\",\n \"created_at\": \"\",\n \"properties\": {\n \"deserunt_cc\": false,\n \"pariatur01\": 19746069.41750388,\n \"nostrud35\": -83020901.73483716\n }\n }\n ],\n \"page_info\": {\n \"__typename\": \"\",\n \"page_size\": \"\",\n \"after\": \"\",\n \"before\": \"\"\n }\n}", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-e0cdab46-11a5-48e3-afe6-bf6fd144dcdc" } ], "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-e3345e18-9af0-4ee1-8618-35c256da5e99" } ], "id": "3dd7cbca-2244-4ad5-8e83-9bed03f0e0a8", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-3dd7cbca-2244-4ad5-8e83-9bed03f0e0a8" } ], "id": "d00b6622-7991-4ca5-938e-b1a85f539fb5", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-d00b6622-7991-4ca5-938e-b1a85f539fb5" } ], "id": "cd2e8055-049a-4270-b191-8b885915f7ea", "createdAt": "2026-06-05T15:10:30.000Z", "updatedAt": "2026-06-05T15:10:30.000Z", "uid": "35240-cd2e8055-049a-4270-b191-8b885915f7ea" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.knock.app" } ] }