Cvent Emails API

openapi: 3.0.2
info:
  title: Cvent REST APIs — Emails
  version: ea
  description: Event planners use emails to invite registrants, market their events and request feedback from attendees. Use
    these APIs to get historical data about your emails and see relevant details like the types of emails sent, the recipient,
    and delivery status.
  contact:
    name: Cvent Development Platform
    url: https://developers.cvent.com/
externalDocs:
  description: Cvent REST API documentation
  url: https://developers.cvent.com/documentation
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Emails
  description: Event planners use emails to invite registrants, market their events and request feedback from attendees. Use
    these APIs to get historical data about your emails and see relevant details like the types of emails sent, the recipient,
    and delivery status.
paths:
  /bounces:
    get:
      summary: List Email Bounces
      operationId: getBounceDetails
      description: 'Returns a paginated list of email bounce details in your account.


        Before/after filters can be used to retrieve email bounce data up to six months in the past.

        If no date filter is provided, defaults to 1 month back from the current time.

        '
      tags:
      - Emails
      security:
      - OAuth2.clientCredentials:
        - email/bounces:read
      - OAuth2.authorizationCode:
        - email/bounces:read
      parameters:
      - $ref: '#/components/parameters/commonSpecBefore'
      - $ref: '#/components/parameters/commonSpecAfter'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        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"
        schema:
          type: string
          example: productLine eq 'EVENT'
      responses:
        '200':
          description: Successfully retrieved a list of bounce details of an email.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bounce-details-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /emails:
    get:
      tags:
      - Emails
      operationId: getEmailsHistory
      summary: Get Emails History Data
      description: 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.
      security:
      - OAuth2.clientCredentials:
        - email/emails:read
      - OAuth2.authorizationCode:
        - email/emails:read
      parameters:
      - $ref: '#/components/parameters/before1'
      - $ref: '#/components/parameters/after1'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        required: false
        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"
        schema:
          type: string
          example: event.id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
      responses:
        '200':
          description: Successfully retrieved a paginated list of emails.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-history-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /emails/{emailRequestId}/status:
    get:
      summary: List Email Status
      operationId: getEmailStatus
      description: 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.
      tags:
      - Emails
      security:
      - OAuth2.clientCredentials:
        - email/email-status:read
      - OAuth2.authorizationCode:
        - email/email-status:read
      parameters:
      - $ref: '#/components/parameters/emailRequestId'
      responses:
        '200':
          description: Successfully retrieved a list of email send statuses associated with particular email request ID.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-send-status'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: true
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
components:
  schemas:
    bounce-details.json:
      title: Bounce details
      type: object
      description: Email bounce details.
      properties:
        recipient:
          $ref: '#/components/schemas/recipient.json'
        bounceReason:
          type: string
          description: Reason of bounce.
          example: 5.7.1 (delivery not authorized)
        bounceDateTime:
          type: string
          format: date-time
          description: ISO 8601 formatted date time (in UTC) when the email bounced or there was an error.
          example: '2023-01-02T02:00:00Z'
        smtpCode:
          type: integer
          description: SMTP code returned by the server in response to an email, indicating the status of the message.
          example: 500
        dsnDiagnostics:
          type: string
          description: Delivery Status Notification (DSN) diagnostic details for the email.
          example: smtp;500 5.7.1 (delivery not authorized)
        optOut:
          type: boolean
          description: True indicates the recipient has requested not to be sent emails.
          example: true
        subject:
          type: string
          description: Subject of email.
          example: Invitation to the event
        productLine:
          $ref: '#/components/schemas/product-line.json'
        productId:
          type: string
          format: uuid
          description: Unique ID of the product.
          example: 2A941E55-3367-4C50-B21B-B6A7613DFB23
        emailType:
          $ref: '#/components/schemas/email-type.json'
        emailId:
          type: string
          format: uuid
          description: Unique ID of the email.
          example: 2A941E55-3367-4C50-B21B-B6A7613DFB23
        created:
          type: string
          format: date-time
          description: The ISO 8601 formatted date time (in UTC) when the email was sent.
          example: '2023-01-01T02:00:00Z'
    pagination-links.json:
      title: PaginationLinks
      type: object
      description: Represents pagination links for navigating between pages of data.
      properties:
        next:
          $ref: '#/components/schemas/link.json'
        self:
          $ref: '#/components/schemas/link.json'
        prev:
          $ref: '#/components/schemas/link.json'
    uuid-property:
      title: UUID Property
      description: A string that has to be a format matching the industry standard uuid
      type: string
      format: uuid
      example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
    attendee-response.json:
      title: Attendee Response
      description: Response object indicating the status of send email request for a particular attendee.
      required:
      - id
      - status
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the attendee you're emailing.
          example: 9A641E55-3367-4C50-B21B-B6A7613DFB23
        status:
          $ref: '#/components/schemas/send-email-status.json'
        errorMessage:
          type: string
          description: The error message contains reason of a failed email.
          example: attendee does not exist.
    paging-no-total-count.json:
      title: Paging
      required:
      - _links
      type: object
      description: Represents pagination information for a collection of resources.
      properties:
        previousToken:
          type: string
          description: The pagination token for the previous page, if one exists. You can use this token to navigate to the
            previous page of data.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        nextToken:
          type: string
          description: The pagination token for the next page. If this value is present in the response, there is another
            page of data you can fetch.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        currentToken:
          type: string
          description: The pagination token for the current page.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        limit:
          type: integer
          description: The number of records to return on the page. Not to exceed 200.
          example: 100
        _links:
          $ref: '#/components/schemas/pagination-links.json'
    email-history-paginated-response:
      title: Email History Paginated Response
      description: The response from a request to get the list of email history. This includes the paging object as well as
        the collection of email history.
      required:
      - paging
      - data
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/email-history.json'
          description: Collection of emails history data.
    send-email-event-response:
      title: Send Event Email Response
      description: Response object containing a request ID and a list of all email responses sent to attendees.
      type: object
      allOf:
      - title: Send Email Response
        description: Response object containing details of email send.
        type: object
        allOf:
        - title: Audit
          description: Audit information
          type: object
          properties:
            created:
              type: string
              format: date-time
              description: The ISO 8601 zoned date time when this record was created.
              readOnly: true
              example: '2017-01-02T02:00:00Z'
            createdBy:
              type: string
              description: The identifier of the user that created this record.
              readOnly: true
              example: hporter
            lastModified:
              type: string
              format: date-time
              description: The ISO 8601 zoned date time when this record was updated.
              readOnly: true
              example: '2019-02-12T03:00:00Z'
            lastModifiedBy:
              type: string
              description: The identifier of the user that last updated this record.
              readOnly: true
              example: hporter
        required:
        - requestId
        properties:
          requestId:
            type: string
            format: uuid
            description: The request ID for the email send request.
            example: 3A541E55-3367-4C50-B21B-B6A7613DFB23
          status:
            $ref: '#/components/schemas/send-email-request-status.json'
          description:
            type: string
            description: The description of the response. If the `status` is `ERROR`, this field contains the reason for the
              failure.
            example: Cannot send an email from deleted event.
      required:
      - event
      - email
      - resendToPreviousRecipients
      - attendeeResponse
      properties:
        event:
          $ref: '#/components/schemas/event.json3'
        email:
          $ref: '#/components/schemas/email.json'
        resendToPreviousRecipients:
          type: boolean
          description: True indicates this email should be resent to attendees who had already received this email previously.
          example: true
        attendeeResponses:
          type: array
          minItems: 1
          maxItems: 200
          items:
            $ref: '#/components/schemas/attendee-response.json'
          description: List of responses specifying the status of email request for each attendee.
    send-email-status.json:
      title: Send Email Status
      enum:
      - Sent
      - In-Progress
      - Error
      - Opted-Out
      type: string
      description: It is used to denote the status of the sent email.
      example: Accepted
    email-type.json:
      title: EmailType
      enum:
      - Invitation
      - Invitation Reminder
      - Registration Confirmation
      - Regret
      - Post Event Feedback
      - Custom Invitee Message
      - Custom Declinee Message
      - Event Reminder
      - Custom Attendee Message
      - Custom One-Time Message
      - Planner Report
      - Event Update
      - Custom Undecided Message
      - Custom Attended Message
      - Modification Confirmation
      - Cancellation Confirmation
      - Guest Event Reminder
      - Guest Registration Notification
      - Custom Guest Message
      - Guest Post Event Feedback
      - Invitee Session Email
      - Guest Session Email
      - Approval Pending Notification
      - Approval Denied Notification
      - Administrator Registration Confirmation
      - CrowdCompass Event Guide Invitation
      - CrowdCompass App Download
      - Waitlist Notification
      - Session Waitlist Notification
      - Shoulder Date Notification
      - Selected Roommate Notification
      - Matched Roommate Notification
      - Declined Roommate Notification
      - OnArrival Post Event Feedback
      - OnArrival Guest Post Event Feedback
      - Travel Modification Confirmation
      - Custom
      - New Appointment
      - Appointment Accepted
      - Appointment Declined
      - Appointment Cancelled
      - Appointment Edited
      - Pending Appointment Reminder
      - Upcoming Appointment Reminder
      - Attendee Removed
      - Opt In Email
      - Resource Center Invitation
      - Single Task Reminder
      - Mobile App Invitation
      - Login Verification Code
      - Save The Date
      - All Tasks Reminder
      - Exhibitor Admin Invitation
      - Exhibitor Admin Reminder
      - Exhibitor Device Rental Access Code
      - Exhibitor App License Access Code
      - Exhibitor Leads Export
      - Stakeholder Feedback Invitation
      - Exhibitor Task Reminder
      - LeadCapture Requested Materials
      - Integration Alerts
      - Unknown
      type: string
      description: Denotes the type of the email.
      example: Invitation
    ErrorResponseBase1:
      title: ErrorResponseBase
      type: object
      description: Represents an error response with no additional details.
      required:
      - code
      - message
      properties:
        code:
          type: integer
          description: The HTTP status code representing the error.
          example: 400
        message:
          type: string
          description: A brief description of the error.
          example: Bad Request
        target:
          type: string
          description: The target resource of the error.
          example: example target
    bounce-details-response:
      title: Paginated Bounce Details
      description: The response from a request to get the bounce details of an email. This includes paging object
      required:
      - paging
      - data
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/paging-no-total-count.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/bounce-details.json'
          description: Bounce details.
    product-line.json:
      title: ProductLine
      enum:
      - ABSTRACT_MANAGEMENT
      - ADMIN
      - API_PLATFORM
      - APPOINTMENTS
      - AUTO_BLOCK
      - BOOK
      - CHANNEL_PUBLISHER
      - CONTACT
      - CROWD_COMPASS
      - CSN
      - DASHBOARD
      - DEFAULT
      - E_MARKETING
      - ENGAGEMENTS_AND_PROJECTS
      - EVENT
      - LEGACY_SURVEY
      - MEMBERSHIP
      - OPT_IN
      - ORGANIZATION
      - OSS
      - PORTAL
      - RATE_INTEGRITY
      - RES_DESK
      - REVERSE_AUCTION
      - RFP
      - RFP_ALERTS
      - RFP_PUBLISHER
      - STARGATE
      - SURVEY
      - USER_ADMINISTRATION
      - VAULT_MAIL
      type: string
      description: Cvent product lines or additional features.
      example: EVENT
    paging.json:
      title: Paging
      required:
      - _links
      type: object
      description: Represents pagination information for a collection of resources.
      properties:
        previousToken:
          type: string
          description: The pagination token for the previous page, if one exists. You can use this token to navigate to the
            previous page of data.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        nextToken:
          type: string
          description: The pagination token for the next page. If this value is present in the response, there is another
            page of data you can fetch.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        currentToken:
          type: string
          description: The pagination token for the current page.
          example: 1a2b3c4d5e6f7g8h9i10j11k
        limit:
          type: integer
          description: The number of records to return on the page. Not to exceed 200.
          example: 100
        totalCount:
          type: integer
          description: The total number of records available. This field may return blank, even if there are more records.
            To confirm if there are more records, check the `nextToken` field.
          example: 2
        _links:
          $ref: '#/components/schemas/pagination-links.json'
    recipients-data.json:
      title: Recipients Data
      description: Recipient data contains the recipient's details like ID, name and status of email sent to that recipient.
      type: object
      properties:
        recipientId:
          type: string
          format: uuid
          description: Unique ID of a recipient.
          example: 2A941E55-3367-4C50-B21B-B6A7613DFB23
        recipientName:
          type: string
          description: Name of the recipient.
          example: User
        status:
          $ref: '#/components/schemas/send-email-status.json'
    email-history.json:
      title: Email History
      type: object
      description: Email History record.
      allOf:
      - $ref: '#/components/schemas/send-email-event-response/allOf/0/allOf/0'
      properties:
        id:
          type: string
          description: Unique Id of an email history record.
          example: kn4rznpgm2cx43-qx47948p
        event:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/uuid-property'
          required:
          - id
          description: Event Id for email history record.
        contact:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/uuid-property'
          required:
          - id
          description: Contact Id for email history record.
        attendee:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/uuid-property'
          required:
          - id
          description: Attendee Id for email history record.
        subject:
          type: string
          description: Subject of the email.
          example: Event Invitation
        from:
          type: string
          description: From email address of the email.
          example: example@example.com
        to:
          type: string
          description: Recipient address of the email.
          example: example@example.com
        type:
          $ref: '#/components/schemas/email-type.json'
        sent:
          type: string
          description: The ISO 8601 zoned date time when this email was sent.
          format: date-time
          example: '2017-01-02T02:30:00Z'
        status:
          $ref: '#/components/schemas/email-status.json'
        undeliverable:
          type: boolean
          description: Flag to indicate if email was undelivered.
          example: false
        opened:
          type: boolean
          description: Flag to indicate if email was opened.
          example: false
        firstOpened:
          type: string
          description: The ISO 8601 zoned date time when the email was first opened.
          format: date-time
          example: '2017-01-02T02:30:00Z'
        clicked:
          type: boolean
          description: Flag to indicate if any link in the email was clicked.
          example: false
        firstClicked:
          type: string
          description: The ISO 8601 zoned date time when any link in the email was first clicked.
          format: date-time
          example: '2017-01-02T02:30:00Z'
        bounced:
          type: boolean
          description: Flag to indicate if the email was bounced.
          example: false
    event.json3:
      title: Event
      description: Details of the event.
      type: object
      required:
      - id
      properties:
        id:
          type: string
          format: uuid
          example: a150f1ee-6c54-4b01-90e6-d701748f0851
          description: The unique ID of the event.
    link.json:
      title: Link
      required:
      - href
      type: object
      description: Represents a link to a related resource.
      properties:
        href:
          type: string
          description: A url provided that can be followed for linking
          example: ?token=90c5f062-76ad-4ea4-aa53-00eb698d9262
    email.json:
      title: Email
      description: Details of an email to be send.
      type: object
      required:
      - id
      properties:
        id:
          type: string
          format: uuid
          example: a150f1ee-6c54-4b01-90e6-d701748f0851
          description: The unique ID of the email to be sent.
    email-status.json:
      title: EmailStatus
      enum:
      - Sent
      - Failed
      type: string
      description: This is used to denote the status of the email sending
      example: Sent
    send-email-request-status.json:
      title: Send Email Request Status
      enum:
      - ERROR
      - IN-PROGRESS
      - SUCCESSFUL
      type: string
      description: Denotes the status of the send email request.
      example: ERROR
    recipient.json:
      title: Recipient
      type: object
      description: Information of the recipient.
      properties:
        id:
          type: string
          format: uuid
          description: Unique ID of the recipient.
          example: 2A941E55-3367-4C50-B21B-B6A7613DFB23
        firstName:
          type: string
          description: First name of the recipient.
          example: Brett
        lastName:
          type: string
          description: Last name of the recipient.
          example: Lawler
        emailAddress:
          type: string
          description: Email address of the recipient.
          example: brett.lawler@example.com
    email-send-status:
      title: Email send status
      description: The response from a request to get the list of recipients with email status.
      required:
      - emailRequestId
      - requestedDate
      - requestedBy
      - recipientStatus
      type: object
      properties:
        emailRequestId:
          type: string
          format: uuid
          description: ID of the send email request.
          example: 3A541E55-3367-4C50-B21B-B6A7613DFB23
        requestedDate:
          type: string
          format: date-time
          description: The ISO 8601 zoned date time (in UTC) when this request was made.
          readOnly: true
          example: '2017-01-02T02:00:00Z'
        requestedBy:
          type: string
          description: The identifier of the user that requested this record.
          readOnly: true
          example: Requester
        recipientStatus:
          type: array
          items:
            $ref: '#/components/schemas/recipients-data.json'
          maxItems: 200
          description: A list of recipients to whom emails were tried to send.
    ErrorResponse-12:
      title: ErrorResponse
      description: Represents an error response with additional details of cascading error messages.
      allOf:
      - $ref: '#/components/schemas/ErrorResponseBase1'
      type: object
      required:
      - code
      - message
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseBase1'
          description: Additional details of cascading error messages.
  responses:
    NotFound1:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse-12'
          example:
            code: 404
            message: Not found
    BadRequest1:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse-12'
          example:
            code: 400
            message: Bad Request
    TooManyRequests1:
      description: Too many requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse-12'
          example:
            code: 429
            message: Limit Exceeded
    Unauthorized1:
      description: Bad or expired token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse-12'
          example:
            code: 401
            message: Unauthorized
    Forbidden1:
      description: You do not have access to the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse-12'
          example:
            code: 403
            message: Access Forbidden
  parameters:
    emailRequestId:
      in: path
      name: emailRequestId
      description: Used to get status of emails which were sent with this email request ID.
      required: true
      schema:
        type: string
        format: uuid,
        example: 2A941E55-3367-4C50-B21B-B6A7613DFB23
    commonSpecBefore:
      name: before
      required: false
      in: query
      description: Used to query records that have been added or updated before this time point.
      schema:
        type: string
        format: date-time
        example: '2017-01-02T02:00:00Z'
    after1:
      in: query
      name: after
      description: Used to query records that have been created after this time point. Defaults to 6 months back from current
        time.
      required: false
      schema:
        type: string
        example: '2021-03-26T02:30:00Z'
    token:
      name: token
      in: query
      description: 'The continuation token returned from a previous class. This must be a valid UUID v4 if provided.

        This will override any other pageable parameters provided.

        '
      style: form
      explode: true
      schema:
        type: string
        example: 0e28af57-511f-47ab-ae46-46cd1ca51a1a
    before1:
      in: query
      name: before
      description: Used to query records that have been created before this time point. Defaults to current time.
      required: false
      schema:
        type: string
        example: '2021-03-25T02:30:00Z'
    commonSpecAfter:
      name: after
      required: false
      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.
      in: query
      schema:
        type: string
        format: date-time
        example: '2017-01-02T02:00:00Z'
    limit:
      name: limit
      in: query
      description: The maximum number of records to return per page.
      style: form
      explode: true
      schema:
        maximum: 200
        minimum: 1
        type: integer
        default: 100
        example: 100
  securitySchemes:
    OAuth2.clientCredentials:
      type: oauth2
      description: OAuth2 Client Credentials Flow.
      flows:
        clientCredentials:
          tokenUrl: https://api-platform.cvent.com/ea/oauth2/token
          scopes:
            account/hooks:delete: Allows the deletion of hooks.
            account/hooks:read: Allows the reading of hooks.
            account/hooks:write: Allows the creation/updation of hooks.
            account/user-groups:delete: Allows deletion for user groups
            account/user-groups:read: Allows the reading of user groups
            account/user-groups:write: Allows the writing of user groups
            account/users:delete: Allows the deletion of User
            account/users:read: Allows the reading of User, User Group
            account/users:write: Allows the creation/updating of User
            appointments/appointment-attendees:read: Allows the reading of appointment attendees and their related entities.
            appointments/appointment-events:read: Allows the reading of appointment events and their related entities.
            appointments/appointment-types:read: Allows the reading of appointment types and their related entities.
            appointments/appointments:read: Allows the reading of appointment and their related entities.
            appointments/appointments:write: Allows the writing of appointments and their related entities.
            appointments/available-times:read: Allows the reading of availability times.
            appointments/locations:read: Allows the reading of appointment locations and their related entities.
            attendee-insights/attendee-insights:read: Allows the reading of engagement scores (attendee insights).
            attendee-insights/scores:read: Allows the reading of scores.
            attendee-insights/stats:read: Allows the reading of engagement score (attendee insight) stats.
            budget/budget-items:delete: Allows the deletion of budget items
            budget/budget-items:read: Allows the reading of all budget items
            budget/budget-items:write: Allows creation/updation of budget item
            budget/budget-totals:read: Allows the reading of all event budget totals
            budget/budget-vendors:read: Allows reading of account-level budget vendors.
            budget/cards:read: Allows the reading of cards
            budget/currency-conversion-rate:delete: Allows deletion of cu

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent/refs/heads/main/openapi/cvent-emails-api-openapi.yml