{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Subscription API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Subscription",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Show Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to show."
              }
            ]
          },
          "docs": "Shows a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the user subscription to delete."
              }
            ]
          },
          "docs": "Deletes a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Enable Subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/:subscriptionId/enable",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to enable."
              }
            ]
          },
          "docs": "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/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Disable Subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/:subscriptionId/disable",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to disable."
              }
            ]
          },
          "docs": "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/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Show Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me/:subscriptionId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to show."
              }
            ]
          },
          "docs": "Shows a [subscription](https://docs.coveo.com/en/248/)</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me/:subscriptionId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/).</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me/:subscriptionId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the user subscription to delete."
              }
            ]
          },
          "docs": "Deletes a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/)</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Enable Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/enable",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to enable."
              }
            ]
          },
          "docs": "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/)</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VI"
        },
        {
          "info": {
            "name": "Disable Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/disable",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to disable."
              }
            ]
          },
          "docs": "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/)</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"typ"
        },
        {
          "info": {
            "name": "List Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ]
          },
          "docs": "Lists all [subscriptions](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a [subscription](https://docs.coveo.com/en/248/)<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Test Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/:subscriptionId/test",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to test."
              }
            ]
          },
          "docs": "Tests a [subscription](https://docs.coveo.com/en/248/) in a [Coveo organization](https://docs.coveo.com/en/185/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SUBSCRIPTION\",\"type\":\"EDIT\",\"targetId\":\"{subscriptionId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Subscriptions for Current Member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ]
          },
          "docs": "Lists all [subscriptions](https://docs.coveo.com/en/248/) of the current [member](https://docs.coveo.com/en/2869/).</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/)</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Test Subscription for Current Member",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/subscriptions/me/:subscriptionId/test",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "subscriptionId",
                "value": "z5zoxmpor75utkwavbyms2ngla",
                "type": "path",
                "description": "The unique identifier of the subscription to test."
              }
            ]
          },
          "docs": "Tests a [subscription](https://docs.coveo.com/en/248/) for the current [member](https://docs.coveo.com/en/2869/)</br>**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.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ACTIVITIES\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}