Cvent Campaigns API

openapi: 3.0.2
info:
  title: Cvent REST APIs — Campaigns
  version: ea
  description: Planners use eMarketing campaigns to contact an audience, such as newsletters, press releases, or product updates.
    Campaign emails are used as newsletters, promotions, advertisements, or marketing messages. Use these APIs to send an
    email and get historical data about your campaigns.
  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: Campaigns
  description: Planners use eMarketing campaigns to contact an audience, such as newsletters, press releases, or product updates.
    Campaign emails are used as newsletters, promotions, advertisements, or marketing messages. Use these APIs to send an
    email and get historical data about your campaigns.
paths:
  /campaigns:
    get:
      summary: List eMarketing Campaigns
      operationId: getCampaigns
      description: Gets a list of eMarketing campaigns.
      tags:
      - Campaigns
      security:
      - OAuth2.clientCredentials:
        - eMarketing/campaigns:read
      - OAuth2.authorizationCode:
        - eMarketing/campaigns: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  * not equal: ne\n  * greater or equal: ge\n  * less than or equal: le\n\nThe following fields are filterable:\n\
          \  * campaign.name (eq|ne)\n  * campaign.id (eq|ne)\n  * campaign.active (eq|ne)\n  * created (eq|le|ge)\n  * lastModified\
          \ (eq|le|ge)\n"
        schema:
          type: string
          example: campaign.active eq '1'
      responses:
        '200':
          description: Successfully retrieved a paginated list of eMarketing campaigns.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/campaign-list-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'
  /emarketing/campaigns/{campaignId}/email-templates:
    get:
      summary: List Email Templates
      operationId: getEmailTemplates
      description: Gets a list of eMarketing email templates.
      tags:
      - Campaigns
      security:
      - OAuth2.clientCredentials:
        - eMarketing/eMarketing-email-templates:read
      - OAuth2.authorizationCode:
        - eMarketing/eMarketing-email-templates:read
      parameters:
      - $ref: '#/components/parameters/before1'
      - $ref: '#/components/parameters/after1'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/campaignId'
      - 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\nThe following fields are filterable:\n  * name (eq)\n  * createdBy (eq)\n"
        schema:
          type: string
          example: emailName eq 'Invitation'
      responses:
        '200':
          description: Successfully retrieved a paginated list of email templates for a campaign.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-template-paginated-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'
  /emarketing/emails:
    post:
      summary: Send Email To Recipients
      operationId: sendEMarketingEmails
      description: Sends an email to one or more eMarketing campaign recipients who are on the recipient list.
      tags:
      - Campaigns
      security:
      - OAuth2.clientCredentials:
        - eMarketing/eMarketing-send-emails:write
      - OAuth2.authorizationCode:
        - eMarketing/eMarketing-send-emails:write
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/send-email-request'
      responses:
        '202':
          description: Successfully sent the request(s) for processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/send-email-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'
  /emarketing/emails/{emailRequestId}/status:
    get:
      summary: List Emarketing Email Status
      operationId: getEmarketingEmailStatus
      description: Gets the status of email using unique email request ID that was generated as a response of [Send Email
        To Recipients](#tag/Campaigns/operation/sendEMarketingEmails) request.
      tags:
      - Campaigns
      security:
      - OAuth2.clientCredentials:
        - emarketing/emarketing-email-status:read
      - OAuth2.authorizationCode:
        - emarketing/emarketing-email-status:read
      parameters:
      - $ref: '#/components/parameters/emailRequestId'
      responses:
        '200':
          description: Successfully retrieved a list of emarketing email send statuses associated with particular email request
            ID.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/send-email-emarketing-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'
components:
  schemas:
    email-template-data.json:
      title: Email Template Response
      description: Response object to get email templates for an unique campaign.
      allOf:
      - title: EmailTemplateCommon
        description: Email Template
        type: object
        allOf:
        - $ref: '#/components/schemas/send-email-event-response/allOf/0/allOf/0'
        properties:
          name:
            type: string
            description: Name of the email template.
            example: Invitation
          subject:
            type: string
            description: Subject of the email template.
            example: Email Template Testing
          fromName:
            type: string
            description: Name of the sender.
            example: Henry Potterfield
          fromEmail:
            type: string
            description: The email address of the sender.
            example: h.potterfield@test.com
          plaintextBody:
            type: string
            description: Plain text body of the page in the email.
            example: We’d love to hear your thoughts!\n\nPlease take a few minutes to let us know about your recent experience.\n\nStart
              Survey Now ({[RES-SURVEY URL]})
          htmlBody:
            type: string
            description: html body of the page sent in the email
            example: '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html><head><title></title></head><body
              style="margin:0;padding:0" id="body"><table ><tbody><tr><td align="center" bgcolor="#041532"><table ><tbody><tr><td
              align="center" bgcolor="#DDE2E6" style="padding-top:0;padding-bottom:0;padding-left:0;padding-right:0"><table
              border="0" cellpadding="0" cellspacing="0" width="100%" style="max-width:600px" class="wrapper"><tbody><tr><td><table><tbody><tr><td
              valign="top"><table><tbody><tr><td><table><tbody><tr><td bgcolor="transparent" style="padding-top:15px;padding-bottom:15px;padding-left:15px;padding-right:15px"><table><tbody><tr><td><table
              border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td>{[C-FIRST NAME]}, <br></td></tr> <tr><td>We&#x2019;d
              love to hear your thoughts!</td></tr> </table></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr><tr><td
              valign="top"><table border="0" cellpadding="0" cellspacing="0" width="100%" align="left" class="column"><tbody><tr><td><table
              border="0" cellpadding="0" cellspacing="0" width="100%" data-cvent-id="widget-NucleusText-widget:13ea36d2-1eb4-452f-ae17-9d582dbeb7eb"><tbody><tr><td
              bgcolor="transparent" style="padding-top:15px;padding-bottom:15px;padding-left:15px;padding-right:15px"><table
              border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td><table><tr><td>Please take a few minutes
              to let us know about your recent experience.</td></tr> </table></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr><tr><td
              valign="top"><table><tbody><tr><td><table><tbody><tr><td><table><tbody><tr><td >Start Survey Now</a></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr><tr><td
              valign="top"><table border="0" cellpadding="0" cellspacing="0" width="100%" align="left" class="column"><tbody><tr><td><table
              ><tbody><tr><td bgcolor="transparent" style="padding-top:15px;padding-bottom:15px;padding-left:15px;padding-right:15px"><table
              ><tbody><tr><td><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td style="font-size:16px;line-height:20px;font-family:Arial,Helvetica,sans-serif;color:#273F69;font-style:normal;font-weight:400;text-align:center;
              padding: 6px 0;">If you have any questions, feel free to email us at {[SUR-AUTHOR EMAIL]}.<br>Thank you,<br>{[SUR-AUTHOR
              COMPANY]}&#xA0;</td></tr> </table></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr><tr><td
              valign="top"><table><tbody><tr><td><table><tbody><tr><td bgcolor="transparent" style="padding-top:15px;padding-bottom:15px;padding-left:15px;padding-right:15px"><table
              ><tbody><tr><td><table><tr><td>Click the link below to opt out of receiving emails from {[SUR-AUTHOR FIRST NAME]}
              {[SUR-AUTHOR LAST NAME]}.<br>{[EMAIL OPT OUT]}&#xA0;</td></tr> </table></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody></table></td></tr><tr><td><table><tbody><tr><td><table><tbody></tbody></table></td></tr></tbody></table></td></tr></tbody></table>
              ></td></tr></tbody></table></body></html>'
          locale:
            type: string
            description: The locale of the email template using the IETF Language Tag format.
            example: en-US
          clickTrackingEnabled:
            type: boolean
            description: Enables tracking when respondent clicks on the email
            example: true
          replyToName:
            type: string
            description: Name of the person to reply to
            example: Henry Potterfield
          replyToEmail:
            type: string
            description: Email address to reply to
            example: h.potterfield@test.com
      properties:
        id:
          type: string
          description: The ID of the eMarketing email.
          example: '12345'
        active:
          type: boolean
          description: True indicates the email will be active and can be sent.
          example: true
    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'
    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.
    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
    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
    email-template-paginated-response:
      title: Email template List Paginated Response
      description: The response from a request to get the list of email templates. This includes the paging object as well
        as the collection of email template.
      required:
      - paging
      - data
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/email-template-data.json'
          description: A list of all email templates data for an unique campaign that will help the planner to select specific
            email and send.
    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'
    send-email-request:
      title: Send EMarketing Email Request
      description: Request object to send an email to one or more eMarketing campaign recipients.
      required:
      - templateId
      - recipients
      type: object
      properties:
        templateId:
          type: string
          description: The template ID of the eMarketing email to be sent.
          example: '12345'
        recipients:
          type: array
          minItems: 1
          maxItems: 200
          items:
            $ref: '#/components/schemas/recipients-request.json'
          description: Array of one or more recipients whom emails need to be sent.
    campaign-list-paginated-response:
      title: Campaign List Paginated Response
      description: The response from a request to get the list of campaign. This includes the paging object as well as the
        collection of campaign data.
      required:
      - paging
      - data
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/campaign-data.json'
          description: A list of all campaigns.
    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.
    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.
    send-email-emarketing-response:
      title: Send Emarketing Email Response
      description: Response object containing a request ID and a list of all email responses sent to recipients.
      type: object
      allOf:
      - $ref: '#/components/schemas/send-email-event-response/allOf/0'
      required:
      - templateId
      - recipientResponse
      properties:
        templateId:
          type: string
          description: The template ID of the eMarketing email.
          example: 12345::2023-09-22T08:34:21.593Z
        recipientResponse:
          type: array
          minItems: 1
          maxItems: 200
          items:
            $ref: '#/components/schemas/recipients-response.json'
          description: List of responses specifying the status of email request for each recipient.
    campaign-data.json:
      title: Campaign Data
      type: object
      description: Campaign data model.
      allOf:
      - $ref: '#/components/schemas/send-email-event-response/allOf/0/allOf/0'
      properties:
        campaignId:
          type: string
          format: uuid
          description: Unique ID of a campaign.
          example: 2A941E55-3367-4C50-B21B-B6A7613DFB23
        campaignName:
          type: string
          description: Name of the campaign.
          example: Demo Campaign
        active:
          type: boolean
          description: True indicates the campaign is active.
          example: true
        clickTrackingEnabled:
          type: boolean
          description: True indicates click tracking is enabled in the campaign.
          example: true
        companyName:
          type: string
          description: Name of the company who is organising the campaign.
          example: Demo Company
        fromName:
          type: string
          description: The name of the person on whose behalf the email will be sent.
          example: Demo name
    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.
    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
    send-email-response:
      title: Send EMarketing Email Response
      description: Response object containing a request ID and a list of all email responses sent to recipients.
      type: object
      required:
      - requestId
      - templateId
      - recipientResponse
      properties:
        requestId:
          type: string
          format: uuid
          description: The request ID for the eMarketing email send request.
          example: 3A541E55-3367-4C50-B21B-B6A7613DFB23
        templateId:
          type: string
          description: The template ID of the eMarketing email.
          example: '12345'
        recipientResponse:
          type: array
          minItems: 1
          maxItems: 200
          items:
            $ref: '#/components/schemas/recipients-response.json'
          description: List of responses specifying the status of email request for each recipient.
        status:
          $ref: '#/components/schemas/send-email-request-status.json'
        description:
          type: string
          description: The description of the request status. If the `status` is `ERROR`, this field contains the reason for
            the failure.
          example: Cannot send an email to inactive campaign(s).
    recipients-response.json:
      title: Email Recipient Response
      description: Response object indicating the status of send email request for a particular recipient.
      required:
      - id
      - status
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the recipient you're emailing.
          example: 9A641E55-3367-4C50-B21B-B6A7613DFB23
        status:
          $ref: '#/components/schemas/send-email-status.json'
        errorMessage:
          type: string
          description: The error description describes the reason of a failed email.
          example: Recipient does not exist.
    recipients-request.json:
      title: Email Recipient Request
      description: Recipient contains the recipient ID of a recipient.
      required:
      - id
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of a recipient whom you'd like to send an email.
          example: 9A641E55-3367-4C50-B21B-B6A7613DFB23
  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
    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'
    campaignId:
      in: path
      name: campaignId
      description: The unique ID of a campaign. Used to retrieve the email templates used in this campaign.
      required: true
      schema:
        type: string
        format: uuid
        example: 9A641E55-3367-4C50-B21B-B6A7613DFB23
    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'
    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

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