{ "info": { "_postman_id": "1b8532f6-1055-4411-b938-7c96de0340a2", "name": "SuprSend Broadcast Object API", "description": "APIs supported on suprsend platform", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "lastUpdatedBy": "35240", "uid": "35240-1b8532f6-1055-4411-b938-7c96de0340a2" }, "item": [ { "name": "v1", "item": [ { "name": "object", "item": [ { "name": "{object_type}", "item": [ { "name": "{id}", "item": [ { "name": "subscription", "item": [ { "name": "Add Subscription", "id": "ce887704-2172-4b04-ab9c-65821f98fe70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"recipients\": [\n {\n \"distinct_id\": \"id1\",\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$locale\": \"\",\n \"$timezone\": \"\"\n },\n {\n \"distinct_id\": \"id1\",\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$locale\": \"\",\n \"$timezone\": \"\"\n }\n ],\n \"properties\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/subscription/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "variable": [ { "id": "ae45fd3e-09d5-4001-807b-4534cab2cc14", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "775b4c48-d3e1-445f-b941-101639b9562e", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to add subscribers (users/child objects) to a given object, to notify subscribers when workflow is triggered on the parent object." }, "response": [ { "id": "78ae0a87-0b10-48e3-98c9-04f38bd53ac8", "name": "200", "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 \"distinct_id\": \"id1\",\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$locale\": \"\",\n \"$timezone\": \"\"\n },\n {\n \"distinct_id\": \"id1\",\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$locale\": \"\",\n \"$timezone\": \"\"\n }\n ],\n \"properties\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/subscription/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"user\": {\n \"distinct_id\": \"\",\n \"updated_at\": \"\"\n },\n \"object\": {\n \"id\": \"\",\n \"object_type\": \"\",\n \"subscriptions_count\": \"\",\n \"updated_at\": \"\"\n },\n \"properties\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-78ae0a87-0b10-48e3-98c9-04f38bd53ac8" }, { "id": "c084e5a6-8b68-402b-85f3-989160c95027", "name": "404 - Not Found", "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 \"distinct_id\": \"id1\",\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$locale\": \"\",\n \"$timezone\": \"\"\n },\n {\n \"distinct_id\": \"id1\",\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$locale\": \"\",\n \"$timezone\": \"\"\n }\n ],\n \"properties\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/subscription/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-c084e5a6-8b68-402b-85f3-989160c95027" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-ce887704-2172-4b04-ab9c-65821f98fe70" }, { "name": "List Object Subscriptions", "id": "ff90ef09-81eb-4fa4-83de-21ab4b968827", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/subscription/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "variable": [ { "id": "7135e751-1503-4dd8-833d-285e4f4216bd", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "f9b88732-0a1f-4031-aad4-d19ea47840a3", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to fetch a paginated list of users or child objects subscribed to a given object." }, "response": [ { "id": "6d60eef7-ba40-4c8f-8874-ea50653dfb1d", "name": "200", "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/object/:object_type/:id/subscription/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"count\": \"\",\n \"limit\": \"\",\n \"has_prev\": \"\",\n \"before\": \"\",\n \"has_next\": \"\",\n \"after\": \"\"\n },\n \"results\": [\n {\n \"user\": {\n \"distinct_id\": \"\",\n \"updated_at\": \"\"\n },\n \"object\": {\n \"id\": \"\",\n \"object_type\": \"\",\n \"subscriptions_count\": \"\",\n \"updated_at\": \"\"\n },\n \"properties\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"user\": {\n \"distinct_id\": \"\",\n \"updated_at\": \"\"\n },\n \"object\": {\n \"id\": \"\",\n \"object_type\": \"\",\n \"subscriptions_count\": \"\",\n \"updated_at\": \"\"\n },\n \"properties\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-6d60eef7-ba40-4c8f-8874-ea50653dfb1d" }, { "id": "9014dbad-1190-4107-a452-c034bba94ae1", "name": "404 - Not Found", "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/object/:object_type/:id/subscription/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-9014dbad-1190-4107-a452-c034bba94ae1" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-ff90ef09-81eb-4fa4-83de-21ab4b968827" }, { "name": "Remove Object Subscriptions", "id": "72785cb3-61a8-4d24-b430-1628dc691ac7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "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/object/:object_type/:id/subscription/?recipients=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "query": [ { "description": "(Required) List of recipients to be notified. Provide recipient IDs as a comma-separated list (e.g., `id1,id2,id3`).", "key": "recipients", "value": "" } ], "variable": [ { "id": "8e060c17-60b3-488c-b776-a5de07040a67", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "5cbb1f0d-53a2-4f7b-b75b-9894b49e08db", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to remove object subscribers (users or child objects)." }, "response": [ { "id": "0b5e3ea4-01b5-4425-9c76-f9ab921aafe9", "name": "204 - No Content", "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/object/:object_type/:id/subscription/?recipients=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "query": [ { "description": "(Required) List of recipients to be notified. Provide recipient IDs as a comma-separated list (e.g., `id1,id2,id3`).", "key": "recipients", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"Result\": {}\n }\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-0b5e3ea4-01b5-4425-9c76-f9ab921aafe9" }, { "id": "83c9ef38-f013-46a8-a184-e2fe978b5086", "name": "404 - Not Found", "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/object/:object_type/:id/subscription/?recipients=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscription", "" ], "query": [ { "description": "(Required) List of recipients to be notified. Provide recipient IDs as a comma-separated list (e.g., `id1,id2,id3`).", "key": "recipients", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-83c9ef38-f013-46a8-a184-e2fe978b5086" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-72785cb3-61a8-4d24-b430-1628dc691ac7" } ], "id": "502e37b8-6fef-4a30-afe7-0df604822490", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-502e37b8-6fef-4a30-afe7-0df604822490" }, { "name": "preference", "item": [ { "name": "category", "item": [ { "name": "{category_slug}", "item": [ { "name": "Category and Channel within Category", "id": "8b889da8-c520-41a7-a3dd-0e94aeb3200e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"preference\": \"opt_in\",\n \"opt_out_channels\": [\n \"\",\n \"\"\n ],\n \"opt_in_channels\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/category/:category_slug/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", ":category_slug", "" ], "query": [ { "description": "to fetch user preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "id": "45cdd98c-8e53-4d16-be7d-c397776c2313", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "b88e032f-5de5-4a07-8289-29131a1829b2", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" }, { "id": "5f72e08f-f7d1-41e8-aeb8-264349c8a764", "key": "category_slug", "value": "", "description": "(Required) notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page" } ] }, "description": "API to update object preferences for a specific notification category." }, "response": [ { "id": "34120997-e611-4033-b7c8-85ea3d240a31", "name": "202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"preference\": \"opt_in\",\n \"opt_out_channels\": [\n \"\",\n \"\"\n ],\n \"opt_in_channels\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/category/:category_slug/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", ":category_slug", "" ], "query": [ { "description": "to fetch user preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" }, { "key": "category_slug" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"original_preference\": \"opt_out\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-34120997-e611-4033-b7c8-85ea3d240a31" }, { "id": "c17826b7-ac05-443a-b649-76b628c25d6d", "name": "404 - Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"preference\": \"opt_in\",\n \"opt_out_channels\": [\n \"\",\n \"\"\n ],\n \"opt_in_channels\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/category/:category_slug/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", ":category_slug", "" ], "query": [ { "description": "to fetch user preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" }, { "key": "category_slug" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-c17826b7-ac05-443a-b649-76b628c25d6d" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-8b889da8-c520-41a7-a3dd-0e94aeb3200e" }, { "name": "Single Category", "id": "dbcd07f4-33a7-47eb-9eba-949be4c0fd5d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/category/:category_slug/?tenant_id=&show_opt_out_channels=false&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", ":category_slug", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file.\nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "id": "2d7f8a38-7694-4aaa-b653-f08f079e63bf", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "5e452b77-1256-4fd6-8aee-d192da0f85d2", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" }, { "id": "055a01d0-1f61-402b-b215-5475e474ddab", "key": "category_slug", "value": "", "description": "(Required) notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page" } ] }, "description": "API to fetch object preferences for a given category." }, "response": [ { "id": "fd765330-b679-4729-9d20-7c1f49367c4b", "name": "200", "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/object/:object_type/:id/preference/category/:category_slug/?tenant_id=&show_opt_out_channels=false&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", ":category_slug", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file.\nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" }, { "key": "category_slug" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"original_preference\": \"opt_in\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-fd765330-b679-4729-9d20-7c1f49367c4b" }, { "id": "7f60f244-26ab-4b17-b498-aa3758bed387", "name": "404 - Not Found", "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/object/:object_type/:id/preference/category/:category_slug/?tenant_id=&show_opt_out_channels=false&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", ":category_slug", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file.\nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" }, { "key": "category_slug" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-7f60f244-26ab-4b17-b498-aa3758bed387" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-dbcd07f4-33a7-47eb-9eba-949be4c0fd5d" } ], "id": "e3df9ed3-3187-44b8-93a0-a936de645cad", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-e3df9ed3-3187-44b8-93a0-a936de645cad" }, { "name": "All Categories", "id": "c6adca85-322f-4e28-aab0-78ce7c040eb1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/category/?tenant_id=&show_opt_out_channels=false&tags=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.\nYou can apply single tag filter like `tags=tag1` or build nested conditions using logical operators - `and`, `or`, `not`, `exists`.\n\nExample:\n```\ntags=admin\ntags={\"or\":[{\"and\":[\"admin\",\"sales\"]},{\"and\":[\"admin\",\"manager\"]}]}\ntags={\"not\":\"admin\"}\ntags={\"exists\":true}\n", "key": "tags", "value": "" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file. \nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "id": "6e019f82-c496-4b0c-86f9-3c278e9ae64d", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "fcaada93-330c-4a8b-97c4-5dce195ed686", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to fetch user preferences across all categories." }, "response": [ { "id": "c9c73e6c-1acc-43a9-aa23-86fef152bb12", "name": "200", "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/object/:object_type/:id/preference/category/?tenant_id=&show_opt_out_channels=false&tags=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.\nYou can apply single tag filter like `tags=tag1` or build nested conditions using logical operators - `and`, `or`, `not`, `exists`.\n\nExample:\n```\ntags=admin\ntags={\"or\":[{\"and\":[\"admin\",\"sales\"]},{\"and\":[\"admin\",\"manager\"]}]}\ntags={\"not\":\"admin\"}\ntags={\"exists\":true}\n", "key": "tags", "value": "" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file. \nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\"\n },\n \"results\": [\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"original_preference\": \"opt_in\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"original_preference\": \"opt_in\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-c9c73e6c-1acc-43a9-aa23-86fef152bb12" }, { "id": "a2a79ad9-d3bd-4292-970e-37a09d3f1eb5", "name": "404 - Not Found", "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/object/:object_type/:id/preference/category/?tenant_id=&show_opt_out_channels=false&tags=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "category", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.\nYou can apply single tag filter like `tags=tag1` or build nested conditions using logical operators - `and`, `or`, `not`, `exists`.\n\nExample:\n```\ntags=admin\ntags={\"or\":[{\"and\":[\"admin\",\"sales\"]},{\"and\":[\"admin\",\"manager\"]}]}\ntags={\"not\":\"admin\"}\ntags={\"exists\":true}\n", "key": "tags", "value": "" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file. \nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-a2a79ad9-d3bd-4292-970e-37a09d3f1eb5" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-c6adca85-322f-4e28-aab0-78ce7c040eb1" } ], "id": "c380a288-217c-4cbf-8be5-e732deb3142d", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-c380a288-217c-4cbf-8be5-e732deb3142d" }, { "name": "channel_preference", "item": [ { "name": "Overall Channel level", "id": "d64f5321-e662-41e8-89c9-eba351525538", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_preferences\": [\n {\n \"channel\": \"email\",\n \"is_restricted\": false\n },\n {\n \"channel\": \"email\",\n \"is_restricted\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/channel_preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "channel_preference", "" ], "query": [ { "description": "to fetch user preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "id": "7c8c62c5-edd2-4cb8-b83f-13d2d65efbe6", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "c4e4d729-f102-4a41-9592-3aeaf25ced73", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to update object preferences across all channels." }, "response": [ { "id": "87ab8e81-ecdc-444d-88bc-ae9d4e2a3e33", "name": "202", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_preferences\": [\n {\n \"channel\": \"email\",\n \"is_restricted\": false\n },\n {\n \"channel\": \"email\",\n \"is_restricted\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/channel_preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "channel_preference", "" ], "query": [ { "description": "to fetch user preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-87ab8e81-ecdc-444d-88bc-ae9d4e2a3e33" }, { "id": "c5dbc772-cdb3-40cd-8e5e-ae093dc905fb", "name": "404", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_preferences\": [\n {\n \"channel\": \"email\",\n \"is_restricted\": false\n },\n {\n \"channel\": \"email\",\n \"is_restricted\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/channel_preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "channel_preference", "" ], "query": [ { "description": "to fetch user preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-c5dbc772-cdb3-40cd-8e5e-ae093dc905fb" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-d64f5321-e662-41e8-89c9-eba351525538" }, { "name": "All Channels", "id": "0a34d7af-bd26-48b7-a37b-328232821d8f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/channel_preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "channel_preference", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "id": "3cc7aa20-8af8-44a4-9ea9-34892565395b", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "69f4ec7b-7b75-478a-9f62-60c455714ccf", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to retrieve all channel preferences for a given object." }, "response": [ { "id": "a53b7c89-7a90-44e0-8c24-748588cadf52", "name": "200", "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/object/:object_type/:id/preference/channel_preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "channel_preference", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-a53b7c89-7a90-44e0-8c24-748588cadf52" }, { "id": "7475570a-f7c8-4936-b82b-d772b6d844e0", "name": "404 - Not Found", "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/object/:object_type/:id/preference/channel_preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "channel_preference", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-7475570a-f7c8-4936-b82b-d772b6d844e0" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-0a34d7af-bd26-48b7-a37b-328232821d8f" } ], "id": "3cb5784d-aa78-4dcd-aaf9-999e9ecdc40e", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-3cb5784d-aa78-4dcd-aaf9-999e9ecdc40e" }, { "name": "Full Preference", "id": "a0c8e80a-758b-435a-93c5-713bd6408c40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/?tenant_id=&show_opt_out_channels=false&tags=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.\nYou can apply single tag filter like `tags=tag1` or build nested conditions using logical operators - `and`, `or`, `not`, `exists`.\n\nExample:\n```\ntags=admin\ntags={\"or\":[{\"and\":[\"admin\",\"sales\"]},{\"and\":[\"admin\",\"manager\"]}]}\ntags={\"not\":\"admin\"}\ntags={\"exists\":true}\n", "key": "tags", "value": "" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file.\nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "id": "4f669c64-9b77-4ff8-956e-493ff6b8081e", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "da19974c-24b4-4e4d-ae62-c3f12af799f2", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to fetch object preferences across all channels and categories." }, "response": [ { "id": "1daa474e-24f7-432c-9a8f-e867728c2c9f", "name": "200", "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/object/:object_type/:id/preference/?tenant_id=&show_opt_out_channels=false&tags=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.\nYou can apply single tag filter like `tags=tag1` or build nested conditions using logical operators - `and`, `or`, `not`, `exists`.\n\nExample:\n```\ntags=admin\ntags={\"or\":[{\"and\":[\"admin\",\"sales\"]},{\"and\":[\"admin\",\"manager\"]}]}\ntags={\"not\":\"admin\"}\ntags={\"exists\":true}\n", "key": "tags", "value": "" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file.\nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sections\": [\n {\n \"subcategories\": [\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"subcategories\": [\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-1daa474e-24f7-432c-9a8f-e867728c2c9f" }, { "id": "e45d04c6-8f59-45f3-95ff-a809a28c94ea", "name": "404", "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/object/:object_type/:id/preference/?tenant_id=&show_opt_out_channels=false&tags=&locale=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "" ], "query": [ { "description": "to fetch object preferences for a particular tenant", "key": "tenant_id", "value": "" }, { "description": "set this flag to `true` if you want to fetch channel list for opt-out categories.", "key": "show_opt_out_channels", "value": "false" }, { "description": "Filter preference categories with tags assigned to them. Used to filter preference categories relevant to the user on UI based on their roles, department or teams.\nYou can apply single tag filter like `tags=tag1` or build nested conditions using logical operators - `and`, `or`, `not`, `exists`.\n\nExample:\n```\ntags=admin\ntags={\"or\":[{\"and\":[\"admin\",\"sales\"]},{\"and\":[\"admin\",\"manager\"]}]}\ntags={\"not\":\"admin\"}\ntags={\"exists\":true}\n", "key": "tags", "value": "" }, { "description": "Locale code (e.g., `es`, `fr`, `de`, `ja`, `es-AR`) to fetch preference translations in user's locale. When provided, the API looks for category and section names and descriptions in the respective locale file.\nIf a translation is missing for the requested locale, the system automatically falls back in this order: `locale-region` (e.g., `es-AR`) \u2192 `locale` (e.g., `es`) \u2192 `en` (English - always available).\n", "key": "locale", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-e45d04c6-8f59-45f3-95ff-a809a28c94ea" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-a0c8e80a-758b-435a-93c5-713bd6408c40" }, { "name": "Update Object Full Preference", "id": "3d928dd8-f3f6-4a00-ade8-3fb81ac19cfe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "" ], "query": [ { "description": "to update object preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "id": "080a12ec-2e44-49e3-80ca-67860ad196e4", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "009b9db1-27d8-4ba3-9369-de5478a04fa8", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to update object preferences across all channels and categories with translated names and descriptions in the response." }, "response": [ { "id": "155362a5-b059-4e5b-96eb-16f6c0104781", "name": "200", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "" ], "query": [ { "description": "to update object preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"sections\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subcategories\": [\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"effective_tags\": [\n \"\",\n \"\"\n ],\n \"original_preference\": \"opt_out\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"effective_tags\": [\n \"\",\n \"\"\n ],\n \"original_preference\": \"opt_out\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"subcategories\": [\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"effective_tags\": [\n \"\",\n \"\"\n ],\n \"original_preference\": \"cant_unsubscribe\",\n \"preference\": \"cant_unsubscribe\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_out\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"effective_tags\": [\n \"\",\n \"\"\n ],\n \"original_preference\": \"opt_in\",\n \"preference\": \"cant_unsubscribe\",\n \"is_editable\": \"\",\n \"channels\": [\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n },\n {\n \"channel\": \"\",\n \"preference\": \"opt_in\",\n \"is_editable\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-155362a5-b059-4e5b-96eb-16f6c0104781" }, { "id": "f8b53042-f0bb-409f-bbad-4abbac2ebd61", "name": "404", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"channel_preferences\": [\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n },\n {\n \"channel\": \"\",\n \"is_restricted\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/preference/?tenant_id=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "preference", "" ], "query": [ { "description": "to update object preferences for a particular tenant", "key": "tenant_id", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-f8b53042-f0bb-409f-bbad-4abbac2ebd61" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-3d928dd8-f3f6-4a00-ade8-3fb81ac19cfe" } ], "id": "f69777d8-089f-4ede-ad6a-da2db6ae8d80", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-f69777d8-089f-4ede-ad6a-da2db6ae8d80" }, { "name": "subscribed_to", "item": [ { "name": "object", "item": [ { "name": "Fetch Object subscriptions", "id": "3af8e5c6-884f-43eb-8362-ce309e9c349b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/subscribed_to/object/?limit=&after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscribed_to", "object", "" ], "query": [ { "description": "(Required) number of results to be returned in API response", "key": "limit", "value": "" }, { "description": "(Required) ", "key": "after", "value": "" } ], "variable": [ { "id": "df981a51-23dd-42c9-b94f-7e0f3674a767", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "d44187b4-70e4-4efc-a2bb-764371762219", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to fetch a paginated list of all parent objects that the given child object is subscribed to." }, "response": [ { "id": "cdf3a99b-b82a-4add-8667-42591c256f7f", "name": "200", "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/object/:object_type/:id/subscribed_to/object/?limit=&after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscribed_to", "object", "" ], "query": [ { "description": "(Required) number of results to be returned in API response", "key": "limit", "value": "" }, { "description": "(Required) ", "key": "after", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"count\": \"\",\n \"limit\": \"\",\n \"has_prev\": \"\",\n \"before\": \"\",\n \"has_next\": \"\",\n \"after\": \"\"\n },\n \"results\": [\n {\n \"properties\": {},\n \"object\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"properties\": {},\n \"object\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-cdf3a99b-b82a-4add-8667-42591c256f7f" }, { "id": "5cd9dce1-085d-429c-914b-0621b1e95c5f", "name": "404 - Not Found", "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/object/:object_type/:id/subscribed_to/object/?limit=&after=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "subscribed_to", "object", "" ], "query": [ { "description": "(Required) number of results to be returned in API response", "key": "limit", "value": "" }, { "description": "(Required) ", "key": "after", "value": "" } ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-5cd9dce1-085d-429c-914b-0621b1e95c5f" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-3af8e5c6-884f-43eb-8362-ce309e9c349b" } ], "id": "0787878c-20d7-4732-adc8-1cf151dc979c", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-0787878c-20d7-4732-adc8-1cf151dc979c" } ], "id": "52fad753-a802-4654-8f01-b39905e4a63a", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-52fad753-a802-4654-8f01-b39905e4a63a" }, { "name": "Create / Update Objects", "id": "4ef24204-c72d-4baf-8d99-0d5e244618a6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$timezone\": \"\",\n \"$locale\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "id": "7263a640-6105-4c67-8cd1-ac5af0c64ba4", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "b37d47e1-dadc-4be8-b7b1-3b9672851fbe", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to upsert (create if not exists, update if exists) object by providing a unique object ID and type." }, "response": [ { "id": "83db6efd-cb00-4bb3-8cc8-0a9469f0ddd1", "name": "201 - Created", "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 \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$timezone\": \"\",\n \"$locale\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"object_type\": \"\",\n \"subscriptions_count\": \"\",\n \"properties\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"$\": [\n {\n \"value\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-83db6efd-cb00-4bb3-8cc8-0a9469f0ddd1" }, { "id": "60c4cf9e-6aa9-4870-a1d6-883af98363ad", "name": "400 - Bad Request", "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 \"$email\": [\n \"\",\n \"\"\n ],\n \"$sms\": [\n \"\",\n \"\"\n ],\n \"$whatsapp\": [\n \"\",\n \"\"\n ],\n \"$inbox\": [\n \"\",\n \"\"\n ],\n \"$androidpush\": [\n \"\",\n \"\"\n ],\n \"$iospush\": [\n \"\",\n \"\"\n ],\n \"$slack\": [\n {\n \"email\": \"\",\n \"access_token\": \"\"\n },\n {\n \"email\": \"\",\n \"access_token\": \"\"\n }\n ],\n \"$ms_teams\": [\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n },\n {\n \"tenant_id\": \"\",\n \"service_url\": \"\",\n \"conversation_id\": \"\"\n }\n ],\n \"$timezone\": \"\",\n \"$locale\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-60c4cf9e-6aa9-4870-a1d6-883af98363ad" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-4ef24204-c72d-4baf-8d99-0d5e244618a6" }, { "name": "Fetch Object by id", "id": "bb647fc6-97d3-4e23-8734-4fa62a510d6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "id": "ca4b82b3-5397-4d08-a9f0-36245cf2b72a", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "c9c24842-723e-4d5c-91bd-0f1c7bd27c3c", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to fetch Object details by passing object type and ID." }, "response": [ { "id": "8870ee16-6af2-4005-b9c9-a801a82e33b3", "name": "200 - 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/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"object_type\": \"\",\n \"subscriptions_count\": \"\",\n \"properties\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"$\": [\n {\n \"value\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-8870ee16-6af2-4005-b9c9-a801a82e33b3" }, { "id": "14079a35-d7c0-48f1-8d82-56d26687296e", "name": "404 - Not Found", "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/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-14079a35-d7c0-48f1-8d82-56d26687296e" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-bb647fc6-97d3-4e23-8734-4fa62a510d6f" }, { "name": "Delete an Object", "id": "fb85115c-6819-4735-ad73-76dedfe075c8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "id": "6490fa6e-e5cf-420b-9419-8813ed3786b4", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "e2b2cc24-30a5-4071-9e46-ac116df29cf5", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to permanently delete an object by passing `object_type` and `id`." }, "response": [ { "id": "e808f78f-aaa6-47e1-b0c5-98b831c79d9f", "name": "204 - No Content", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"Result\": {}\n }\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-e808f78f-aaa6-47e1-b0c5-98b831c79d9f" }, { "id": "9bfe0ab0-90ec-4b17-aa56-0bf6d7a8dd37", "name": "404 - Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"code\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-9bfe0ab0-90ec-4b17-aa56-0bf6d7a8dd37" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-fb85115c-6819-4735-ad73-76dedfe075c8" }, { "name": "Edit Object Profile", "id": "b4b8958c-927c-4c27-a16b-6808f2c6f9f0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"$set\": {\n \"esse8c\": \"\"\n },\n \"$unset\": [\n \"\",\n \"\"\n ],\n \"$append\": {\n \"enim6d\": \"\"\n },\n \"$remove\": {\n \"consecteturf1e\": \"\",\n \"animc\": \"\"\n },\n \"$set_once\": {\n \"quis_666\": \"\"\n },\n \"$increment\": {\n \"voluptate2b\": \"\",\n \"ut0a\": \"\",\n \"id4d\": \"\",\n \"consequat_8d\": \"\"\n }\n },\n {\n \"$set\": {\n \"quis_9\": \"\"\n },\n \"$unset\": [\n \"\",\n \"\"\n ],\n \"$append\": {\n \"in8\": \"\",\n \"incididunt_35\": \"\",\n \"qui_5\": \"\"\n },\n \"$remove\": {\n \"amet3_\": \"\",\n \"veniam_1e8\": \"\",\n \"cupidatat_2e\": \"\"\n },\n \"$set_once\": {\n \"essee\": \"\"\n },\n \"$increment\": {\n \"Utb_3\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "id": "b1802558-1092-4591-a6c0-2fcb05acfbb5", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." }, { "id": "3bc43bd8-cf0c-4862-9129-6de82af56e5e", "key": "id", "value": "", "description": "(Required) Unique identifier of the object in your system" } ] }, "description": "API to edit (add/remove) properties and communication-channels for an object." }, "response": [ { "id": "ef89d051-558e-4189-87a4-20fbcfe57ef3", "name": "200 - OK", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"$set\": {\n \"esse8c\": \"\"\n },\n \"$unset\": [\n \"\",\n \"\"\n ],\n \"$append\": {\n \"enim6d\": \"\"\n },\n \"$remove\": {\n \"consecteturf1e\": \"\",\n \"animc\": \"\"\n },\n \"$set_once\": {\n \"quis_666\": \"\"\n },\n \"$increment\": {\n \"voluptate2b\": \"\",\n \"ut0a\": \"\",\n \"id4d\": \"\",\n \"consequat_8d\": \"\"\n }\n },\n {\n \"$set\": {\n \"quis_9\": \"\"\n },\n \"$unset\": [\n \"\",\n \"\"\n ],\n \"$append\": {\n \"in8\": \"\",\n \"incididunt_35\": \"\",\n \"qui_5\": \"\"\n },\n \"$remove\": {\n \"amet3_\": \"\",\n \"veniam_1e8\": \"\",\n \"cupidatat_2e\": \"\"\n },\n \"$set_once\": {\n \"essee\": \"\"\n },\n \"$increment\": {\n \"Utb_3\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"object_type\": \"\",\n \"subscriptions_count\": \"\",\n \"properties\": {},\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"$\": [\n {\n \"value\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n },\n {\n \"value\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-ef89d051-558e-4189-87a4-20fbcfe57ef3" }, { "id": "33533f09-01f0-4174-bed0-09c83fc6b971", "name": "400 - Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"$set\": {\n \"esse8c\": \"\"\n },\n \"$unset\": [\n \"\",\n \"\"\n ],\n \"$append\": {\n \"enim6d\": \"\"\n },\n \"$remove\": {\n \"consecteturf1e\": \"\",\n \"animc\": \"\"\n },\n \"$set_once\": {\n \"quis_666\": \"\"\n },\n \"$increment\": {\n \"voluptate2b\": \"\",\n \"ut0a\": \"\",\n \"id4d\": \"\",\n \"consequat_8d\": \"\"\n }\n },\n {\n \"$set\": {\n \"quis_9\": \"\"\n },\n \"$unset\": [\n \"\",\n \"\"\n ],\n \"$append\": {\n \"in8\": \"\",\n \"incididunt_35\": \"\",\n \"qui_5\": \"\"\n },\n \"$remove\": {\n \"amet3_\": \"\",\n \"veniam_1e8\": \"\",\n \"cupidatat_2e\": \"\"\n },\n \"$set_once\": {\n \"essee\": \"\"\n },\n \"$increment\": {\n \"Utb_3\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/object/:object_type/:id/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", ":id", "" ], "variable": [ { "key": "object_type" }, { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"examples\": {\n \"Result\": {\n \"value\": {\n \"code\": 400,\n \"message\": \"Request body must not be empty\"\n }\n }\n }\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-33533f09-01f0-4174-bed0-09c83fc6b971" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-b4b8958c-927c-4c27-a16b-6808f2c6f9f0" } ], "id": "3814b9dd-b8d4-4553-9ffe-add9b82748a8", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-3814b9dd-b8d4-4553-9ffe-add9b82748a8" }, { "name": "List Objects by type", "id": "5c589efc-8a1e-43ba-ab9b-6559bb249cdc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/object/:object_type/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", "" ], "variable": [ { "id": "16aa9723-5723-4328-8957-6e51e0320466", "key": "object_type", "value": "", "description": "(Required) Used to group similar objects together. Give plural namespace like teams, organizations, and roles." } ] }, "description": "API to fetch paginated list of objects that belong to the specified `object_type`." }, "response": [ { "id": "6c4fb8b8-3c5e-41c0-b53c-fdf7a6fdfcd6", "name": "200 - 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/object/:object_type/", "host": [ "{{baseUrl}}" ], "path": [ "v1", "object", ":object_type", "" ], "variable": [ { "key": "object_type" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"meta\": {\n \"count\": \"\",\n \"limit\": \"\",\n \"has_prev\": \"\",\n \"before\": \"\",\n \"has_next\": \"\",\n \"after\": \"\"\n },\n \"results\": [\n {\n \"object_type\": \"\",\n \"id\": \"\",\n \"subscriptions_count\": \"\",\n \"properties\": {\n \"tempor_c7c\": true,\n \"pariatur89_\": -69953723,\n \"elitef3\": true,\n \"laboris27\": -45558010\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"$inbox\": [\n {\n \"value\": \"\",\n \"id_provider\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n },\n {\n \"value\": \"\",\n \"id_provider\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n }\n ]\n },\n {\n \"object_type\": \"\",\n \"id\": \"\",\n \"subscriptions_count\": \"\",\n \"properties\": {\n \"ea_66e\": -48780481,\n \"veniam_f6\": -56046365.027598985\n },\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"$inbox\": [\n {\n \"value\": \"\",\n \"id_provider\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n },\n {\n \"value\": \"\",\n \"id_provider\": \"\",\n \"status\": \"\",\n \"perma_status\": \"\"\n }\n ]\n }\n ]\n}", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-6c4fb8b8-3c5e-41c0-b53c-fdf7a6fdfcd6" } ], "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-5c589efc-8a1e-43ba-ab9b-6559bb249cdc" } ], "id": "4cbade87-190a-47d3-8d54-a14d1f74b99e", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-4cbade87-190a-47d3-8d54-a14d1f74b99e" } ], "id": "732b4b22-917a-4158-a18e-53177c0aa12b", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-732b4b22-917a-4158-a18e-53177c0aa12b" } ], "id": "3dec3dd0-4e4f-42be-b08b-4ec7478e0a47", "createdAt": "2026-07-28T03:06:17.000Z", "updatedAt": "2026-07-28T03:06:17.000Z", "uid": "35240-3dec3dd0-4e4f-42be-b08b-4ec7478e0a47" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://hub.suprsend.com" } ] }