{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cvent REST APIs — Event Cloud Emails API",
    "version": "ea"
  },
  "items": [
    {
      "info": {
        "name": "Emails",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Email Bounces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/bounces",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated before this time point."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators.\nThe filter adheres to the pattern filter='field' comparisonType 'value'.\n\nEmail type 'Unknown' is not supported in filter.\n\n'OR' is not supported. Only 'AND' operator is supported.\n\n The following comparison types can be used in filter expressions:\n  * equal: eq\n  * not equal: ne\n  * greater or equal: ge\n  * less than or equal: le\n\nThe following fields are filterable:\n  * created     (eq|le|ge)\n  * productLine (eq|ne)\n  * emailType   (eq|ne)\n  * recipient.id (eq)\n  * productId   (eq)\n  * emailId     (eq)\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns a paginated list of email bounce details in your account.\n\nBefore/after filters can be used to retrieve email bounce data up to six months in the past.\nIf no date filter is provided, defaults to 1 month back from the current time.\n"
        },
        {
          "info": {
            "name": "Get Emails History Data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/emails",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been created before this time point. Defaults to current time."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Used to query records that have been created after this time point. Defaults to 6 months back from current time."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records to return per page."
              },
              {
                "name": "token",
                "value": "",
                "type": "query",
                "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter query string narrows search results and supports the combination of logical and comparison operators.\nThe filter adheres to the pattern filter='field' comparisonType 'value'.\n\n'OR' is not supported. Only 'AND' operator is supported.\n\nThe following comparison types can be used in filter expressions:\n  * equal: eq\n  * greater or equal: ge\n  * less than or equal: le\n\nThe following fields are filterable:\n  * event.id (eq)\n  * attendee.id (eq)\n  * contact.id (eq)\n  * status (eq)\n  * lastModified (eq|le|ge)\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns the paginated list of sent emails. Default behaviour is to retrieve all emails for the account. Maximum 6 months of records can be fetched."
        },
        {
          "info": {
            "name": "List Email Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-platform.cvent.com/ea/emails/:emailRequestId/status",
            "params": [
              {
                "name": "emailRequestId",
                "value": "",
                "type": "path",
                "description": "Used to get status of emails which were sent with this email request ID."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Gets the status of emails using unique email request ID that was generated as a response of [Send Email To Recipients](#tag/Campaigns/operation/sendEMarketingEmails) request."
        }
      ]
    }
  ],
  "bundled": true
}