{ "info": { "_postman_id": "ddf44ea2-a710-4aaa-9902-53756dd2961e", "name": "Coveo Activity Activities Subscription API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "lastUpdatedBy": "35240", "uid": "35240-ddf44ea2-a710-4aaa-9902-53756dd2961e" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "subscriptions", "item": [ { "name": "{subscriptionId}", "item": [ { "name": "enable", "item": [ { "name": "Enable Subscription", "id": "1fdf48f2-c2a6-46d4-adf7-08a4321ccdc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId/enable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId", "enable" ], "variable": [ { "id": "e2682a5e-d160-4eb9-bd87-7d090ba7a45e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "9059071c-81e9-48ec-a4cb-c502e9d7aca7", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to enable." } ] }, "description": "Enables a [subscription](https://docs.coveo.com/en/248/) to send [notifications](https://docs.coveo.com/en/221/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n
" }, "response": [ { "id": "69210d8f-7e8b-4b58-b655-6d31e0c77d0f", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId/enable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId", "enable" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-69210d8f-7e8b-4b58-b655-6d31e0c77d0f" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-1fdf48f2-c2a6-46d4-adf7-08a4321ccdc6" } ], "id": "773eb8c6-f8e6-4c54-8a98-84936e01a6b3", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-773eb8c6-f8e6-4c54-8a98-84936e01a6b3" }, { "name": "disable", "item": [ { "name": "Disable Subscription", "id": "9b4e7bde-9ec7-42a4-b45f-5e86a8c37b75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId/disable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId", "disable" ], "variable": [ { "id": "931e7496-5341-4df3-a91b-6cc7b752f23f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "59323f0c-1d15-4818-aacd-c919f00fe3f0", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to disable." } ] }, "description": "Disables a [subscription](https://docs.coveo.com/en/248/) from sending [notifications](https://docs.coveo.com/en/221/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n
" }, "response": [ { "id": "62a5ebb3-26b3-48c3-b156-6e41a380dca7", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId/disable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId", "disable" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-62a5ebb3-26b3-48c3-b156-6e41a380dca7" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-9b4e7bde-9ec7-42a4-b45f-5e86a8c37b75" } ], "id": "ac792505-fd2d-40bc-b8b3-70359b13f7d7", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-ac792505-fd2d-40bc-b8b3-70359b13f7d7" }, { "name": "test", "item": [ { "name": "Test Subscription", "id": "eb9d6e43-8be8-477a-ac85-b3288f9f0730", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId/test", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId", "test" ], "variable": [ { "id": "b40fe41b-8019-4265-a22a-ad55d5fd74f2", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "1c21ba47-8099-495e-8fed-72a63015a098", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to test." } ] }, "description": "Tests a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n
" }, "response": [ { "id": "909613e8-60aa-4c91-a6ac-178b0c9b5ca0", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId/test", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId", "test" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-909613e8-60aa-4c91-a6ac-178b0c9b5ca0" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-eb9d6e43-8be8-477a-ac85-b3288f9f0730" } ], "id": "cf3b3b5f-a018-4066-bc81-fba28e6764df", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-cf3b3b5f-a018-4066-bc81-fba28e6764df" }, { "name": "Show Subscription", "id": "45d6da2a-d188-43de-892a-822b2c087db2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId" ], "variable": [ { "id": "e4282f38-b0ab-4526-b8ec-912a71e18ba9", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "849e4375-5143-4465-bcc6-bd4d73c907e4", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to show." } ] }, "description": "Shows a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "f8b5b2f9-ee1b-4eec-ace8-356825f4434d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"ullamco_1b\": \"\",\n \"non_b47\": \"\",\n \"irure25\": \"\",\n \"sinte\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-f8b5b2f9-ee1b-4eec-ace8-356825f4434d" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-45d6da2a-d188-43de-892a-822b2c087db2" }, { "name": "Update Subscription", "id": "b346e985-863b-4cc7-9a11-e4775018915d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId" ], "variable": [ { "id": "396580bd-3493-4d37-a67c-742941069c4e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "7226adf7-83a1-479a-86ae-490646aa8225", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to update." } ] }, "description": "Updates a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n
" }, "response": [ { "id": "9b3b699f-5adc-4a02-ba7f-80c87cad6060", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"ullamco_1b\": \"\",\n \"non_b47\": \"\",\n \"irure25\": \"\",\n \"sinte\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-9b3b699f-5adc-4a02-ba7f-80c87cad6060" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-b346e985-863b-4cc7-9a11-e4775018915d" }, { "name": "Delete Subscription", "id": "30530708-2049-483f-82dc-57d82c5fa2b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId" ], "variable": [ { "id": "681f89d4-bf72-4ef5-b095-912f956bbe6e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "abedb64c-40c1-4225-ba30-cd5ac10cbd21", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the user subscription to delete." } ] }, "description": "Deletes a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n
" }, "response": [ { "id": "87919b0d-08e2-4d54-87de-124de36dc4a6", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", ":subscriptionId" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-87919b0d-08e2-4d54-87de-124de36dc4a6" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-30530708-2049-483f-82dc-57d82c5fa2b5" } ], "id": "511070e8-5b5e-42ff-9d7a-c263f3ad46bd", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-511070e8-5b5e-42ff-9d7a-c263f3ad46bd" }, { "name": "me", "item": [ { "name": "{subscriptionId}", "item": [ { "name": "enable", "item": [ { "name": "Enable Subscription for Current Member", "id": "c5d68269-9f3a-4ca7-bc26-32e5d74d6800", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/enable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId", "enable" ], "variable": [ { "id": "d9e3e0f3-d3ce-40c7-ad8c-c220ce7c82f4", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "539321db-beb6-44b3-9a70-ee523544cdf0", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to enable." } ] }, "description": "Enables a [subscription](https://docs.coveo.com/en/248/) to send [notifications](https://docs.coveo.com/en/221/) for the current [member](https://docs.coveo.com/en/2869/)
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "3ddd9bed-4a39-4f49-9528-19f14009dabc", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/enable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId", "enable" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-3ddd9bed-4a39-4f49-9528-19f14009dabc" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-c5d68269-9f3a-4ca7-bc26-32e5d74d6800" } ], "id": "68f97a09-50cc-4dc7-8669-8562fa2ffc0b", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-68f97a09-50cc-4dc7-8669-8562fa2ffc0b" }, { "name": "disable", "item": [ { "name": "Disable Subscription for Current Member", "id": "eaf93f26-c962-4ad5-af48-9e531f0d26c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/disable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId", "disable" ], "variable": [ { "id": "174c2d7a-884e-4a88-8538-5840407eb19c", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "522b02b2-2c80-4ad1-b014-059060c0e71b", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to disable." } ] }, "description": "Disables a [subscription](https://docs.coveo.com/en/248/) from sending [notifications](https://docs.coveo.com/en/221/) for the current [member](https://docs.coveo.com/en/2869/)
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "668e2fff-f76c-48fe-a721-7b55dd0618ff", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/disable", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId", "disable" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-668e2fff-f76c-48fe-a721-7b55dd0618ff" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-eaf93f26-c962-4ad5-af48-9e531f0d26c2" } ], "id": "dbde4317-127c-4b3c-850e-364ade4313a1", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-dbde4317-127c-4b3c-850e-364ade4313a1" }, { "name": "test", "item": [ { "name": "Test Subscription for Current Member", "id": "a963432d-be1f-46c6-b4fd-6741e267ef16", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/test", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId", "test" ], "variable": [ { "id": "14339150-f9d0-4fcb-821a-0472373260cf", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "6afc62a5-cecc-458a-9ed6-5ad672323d4b", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to test." } ] }, "description": "Tests a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/)
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "37564c62-e8cc-48ed-be46-717cf1b07c40", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/test", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId", "test" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-37564c62-e8cc-48ed-be46-717cf1b07c40" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-a963432d-be1f-46c6-b4fd-6741e267ef16" } ], "id": "3daa5355-f06f-485f-b62c-96067fcce80e", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-3daa5355-f06f-485f-b62c-96067fcce80e" }, { "name": "Show Subscription for Current Member", "id": "3b51bddc-ffe5-43f1-9104-ed634059b3c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId" ], "variable": [ { "id": "eb9fe426-9a2f-421a-ab9f-87aad79115ad", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "003a40f0-a2c1-43a8-8553-720d73ee0e0b", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to show." } ] }, "description": "Shows a [subscription](https://docs.coveo.com/en/248/)
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "a1bc2189-ae42-4dd4-9ee9-4e2f8c25df9f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"ullamco_1b\": \"\",\n \"non_b47\": \"\",\n \"irure25\": \"\",\n \"sinte\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-a1bc2189-ae42-4dd4-9ee9-4e2f8c25df9f" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-3b51bddc-ffe5-43f1-9104-ed634059b3c2" }, { "name": "Update Subscription for Current Member", "id": "3643b163-d17d-4d4e-a421-2c5d1a7dc464", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId" ], "variable": [ { "id": "5291c1a9-52e7-445c-a2f2-38b986c983ae", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "ba7d7c46-7aea-4c8d-9533-6cfadf76749e", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the subscription to update." } ] }, "description": "Updates a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/).
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "cdd8c332-af42-4800-8114-d1e49817c6f1", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"ullamco_1b\": \"\",\n \"non_b47\": \"\",\n \"irure25\": \"\",\n \"sinte\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-cdd8c332-af42-4800-8114-d1e49817c6f1" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-3643b163-d17d-4d4e-a421-2c5d1a7dc464" }, { "name": "Delete Subscription for Current Member", "id": "318aa7ed-834d-4d14-a6b8-d33534f7f7bc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId" ], "variable": [ { "id": "e70ac523-3b51-40f7-9f9a-5e03a35b0e9f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "2b84be32-2f36-4f5d-b77b-5d02ced6bbff", "key": "subscriptionId", "value": "", "description": "(Required) The unique identifier of the user subscription to delete." } ] }, "description": "Deletes a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/)
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "b585ab65-8e9f-407b-9bb0-4d596e3ba778", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me/:subscriptionId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me", ":subscriptionId" ], "variable": [ { "key": "organizationId" }, { "key": "subscriptionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-b585ab65-8e9f-407b-9bb0-4d596e3ba778" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-318aa7ed-834d-4d14-a6b8-d33534f7f7bc" } ], "id": "3c262f13-46d4-4a39-994f-d92d30bffe09", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-3c262f13-46d4-4a39-994f-d92d30bffe09" }, { "name": "List Subscriptions for Current Member", "id": "8bee6d69-9b66-4a2b-9b50-05c8e9396dcb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me" ], "variable": [ { "id": "1cd8100b-6cf0-42f2-97b2-206af0005237", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Lists all [subscriptions](https://docs.coveo.com/en/248/) of the current [member](https://docs.coveo.com/en/2869/).
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "29f11850-e5bb-4c9d-aaf0-e2673d49050f", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"sint_c8\": \"\",\n \"nisi1b\": \"\",\n \"veniam_04d\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"DAILY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"UNKNOWN\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n },\n {\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"do_a\": \"\",\n \"idabf\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"HOME_PAGE\",\n \"frequency\": \"DAILY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-29f11850-e5bb-4c9d-aaf0-e2673d49050f" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-8bee6d69-9b66-4a2b-9b50-05c8e9396dcb" }, { "name": "Create Subscription for Current Member", "id": "2f5b65aa-6e95-49be-b180-fbcdc75d1135", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me" ], "variable": [ { "id": "f65c85c6-8fa7-4c67-af61-4bf6d7b37d37", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Creates a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/)
**Note:** Only OAuth2 token authentication works when working with user [notifications](https://docs.coveo.com/en/221/). Using API keys will not work as they cannot be traced back to an individual member.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "f9cd9808-aa52-4d47-a046-3749fa293614", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions/me", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions", "me" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"ullamco_1b\": \"\",\n \"non_b47\": \"\",\n \"irure25\": \"\",\n \"sinte\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-f9cd9808-aa52-4d47-a046-3749fa293614" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-2f5b65aa-6e95-49be-b180-fbcdc75d1135" } ], "id": "2bb99ec0-c740-47f8-b800-e168739272b7", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-2bb99ec0-c740-47f8-b800-e168739272b7" }, { "name": "List Subscriptions", "id": "a7f04f2e-f5a9-45ac-a622-ddd728170880", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions" ], "variable": [ { "id": "a1050eb5-718f-41a6-b95c-bde027dae397", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Lists all [subscriptions](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "b62a28d3-707d-45c2-bdff-1f5368cca55e", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions" ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"sint_c8\": \"\",\n \"nisi1b\": \"\",\n \"veniam_04d\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"DAILY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"UNKNOWN\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n },\n {\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"do_a\": \"\",\n \"idabf\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"HOME_PAGE\",\n \"frequency\": \"DAILY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-b62a28d3-707d-45c2-bdff-1f5368cca55e" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-a7f04f2e-f5a9-45ac-a622-ddd728170880" }, { "name": "Create Subscription", "id": "291e3056-4122-4138-9968-333da5fe7b8d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions" ], "variable": [ { "id": "141aa35c-c98c-48ad-ab31-b708e5207777", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Creates a [subscription](https://docs.coveo.com/en/248/)

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "3b87de9e-a58f-4452-8880-66a5b7d6a78a", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"eiusmod2\": \"\",\n \"nisi_77\": \"\",\n \"laborum96\": \"\",\n \"aliquad1\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL_JSON\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "subscriptions" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pattern\": {\n \"content\": {\n \"ullamco_1b\": \"\",\n \"non_b47\": \"\",\n \"irure25\": \"\",\n \"sinte\": \"\"\n },\n \"operations\": [\n \"\",\n \"\"\n ],\n \"resourceTypes\": [\n \"\",\n \"\"\n ],\n \"resultTypes\": [\n \"\",\n \"\"\n ],\n \"eventNames\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"EMAIL\",\n \"frequency\": \"HOURLY\",\n \"parameters\": {\n \"groupId\": \"\",\n \"emailRecipients\": [\n \"\",\n \"\"\n ],\n \"serviceUrl\": \"\",\n \"fromDisplayName\": \"\",\n \"emailSubject\": \"\"\n },\n \"id\": \"\",\n \"organizationId\": \"\",\n \"createdDate\": \"\",\n \"lastModified\": \"\",\n \"userId\": \"\",\n \"status\": {\n \"healthIndicator\": \"PROBLEMATIC\",\n \"statistics\": {\n \"numberOfSuccess\": \"\",\n \"numberOfFailures\": \"\",\n \"numberOfErrors\": \"\",\n \"numberOfCancellations\": \"\"\n },\n \"latestResponseMessage\": \"\"\n },\n \"builtIn\": \"\",\n \"unsubscribedEmails\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-3b87de9e-a58f-4452-8880-66a5b7d6a78a" } ], "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-291e3056-4122-4138-9968-333da5fe7b8d" } ], "id": "b8729bf3-4d6d-4104-921d-aee78e8df2f9", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-b8729bf3-4d6d-4104-921d-aee78e8df2f9" } ], "id": "eb0f2a34-e6b0-4718-a7dc-069ee3e774b8", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-eb0f2a34-e6b0-4718-a7dc-069ee3e774b8" } ], "id": "c64efe5a-b92a-465c-9d31-09dc6f0c50c2", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-c64efe5a-b92a-465c-9d31-09dc6f0c50c2" } ], "id": "4d05101d-f217-404d-8a62-20fbc3998629", "createdAt": "2026-07-28T01:32:57.000Z", "updatedAt": "2026-07-28T01:32:57.000Z", "uid": "35240-4d05101d-f217-404d-8a62-20fbc3998629" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }